Package com.stripe.model.issuing
Class Cardholder
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.issuing.Cardholder
-
- All Implemented Interfaces:
HasId,MetadataStore<Cardholder>,StripeObjectInterface
public class Cardholder extends ApiResource implements HasId, MetadataStore<Cardholder>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCardholder.Billingstatic classCardholder.Companystatic classCardholder.Individualstatic classCardholder.RequirementsGet expandedfront.static classCardholder.SpendingControls-
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON
-
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
-
Constructor Summary
Constructors Constructor Description Cardholder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleancanEqual(java.lang.Object other)static Cardholdercreate(CardholderCreateParams params)Creates a new IssuingCardholderobject that can be issued cards.static Cardholdercreate(CardholderCreateParams params, RequestOptions options)Creates a new IssuingCardholderobject that can be issued cards.static Cardholdercreate(java.util.Map<java.lang.String,java.lang.Object> params)Creates a new IssuingCardholderobject that can be issued cards.static Cardholdercreate(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Creates a new IssuingCardholderobject that can be issued cards.booleanequals(java.lang.Object o)Cardholder.BillinggetBilling()Cardholder.CompanygetCompany()Additional information about acompanycardholder.java.lang.LonggetCreated()Time at which the object was created.java.lang.StringgetEmail()The cardholder's email address.java.lang.StringgetId()Unique identifier for the object.Cardholder.IndividualgetIndividual()Additional information about anindividualcardholder.java.lang.BooleangetLivemode()Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.java.util.Map<java.lang.String,java.lang.String>getMetadata()Set of key-value pairs that you can attach to an object.java.lang.StringgetName()The cardholder's name.java.lang.StringgetObject()String representing the object's type.java.lang.StringgetPhoneNumber()The cardholder's phone number.Cardholder.RequirementsgetRequirements()Cardholder.SpendingControlsgetSpendingControls()Rules that control spending across this cardholder's cards.java.lang.StringgetStatus()Specifies whether to permit authorizations on this cardholder's cards.java.lang.StringgetType()One ofindividualorcompany.inthashCode()static CardholderCollectionlist(CardholderListParams params)Returns a list of IssuingCardholderobjects.static CardholderCollectionlist(CardholderListParams params, RequestOptions options)Returns a list of IssuingCardholderobjects.static CardholderCollectionlist(java.util.Map<java.lang.String,java.lang.Object> params)Returns a list of IssuingCardholderobjects.static CardholderCollectionlist(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Returns a list of IssuingCardholderobjects.static Cardholderretrieve(java.lang.String cardholder)Retrieves an IssuingCardholderobject.static Cardholderretrieve(java.lang.String cardholder, RequestOptions options)Retrieves an IssuingCardholderobject.static Cardholderretrieve(java.lang.String cardholder, CardholderRetrieveParams params, RequestOptions options)Retrieves an IssuingCardholderobject.static Cardholderretrieve(java.lang.String cardholder, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Retrieves an IssuingCardholderobject.voidsetBilling(Cardholder.Billing billing)voidsetCompany(Cardholder.Company company)Additional information about acompanycardholder.voidsetCreated(java.lang.Long created)Time at which the object was created.voidsetEmail(java.lang.String email)The cardholder's email address.voidsetId(java.lang.String id)Unique identifier for the object.voidsetIndividual(Cardholder.Individual individual)Additional information about anindividualcardholder.voidsetLivemode(java.lang.Boolean livemode)Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.voidsetMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)Set of key-value pairs that you can attach to an object.voidsetName(java.lang.String name)The cardholder's name.voidsetObject(java.lang.String object)String representing the object's type.voidsetPhoneNumber(java.lang.String phoneNumber)The cardholder's phone number.voidsetRequirements(Cardholder.Requirements requirements)voidsetSpendingControls(Cardholder.SpendingControls spendingControls)Rules that control spending across this cardholder's cards.voidsetStatus(java.lang.String status)Specifies whether to permit authorizations on this cardholder's cards.voidsetType(java.lang.String type)One ofindividualorcompany.Cardholderupdate(CardholderUpdateParams params)Updates the specified IssuingCardholderobject by setting the values of the parameters passed.Cardholderupdate(CardholderUpdateParams params, RequestOptions options)Updates the specified IssuingCardholderobject by setting the values of the parameters passed.Cardholderupdate(java.util.Map<java.lang.String,java.lang.Object> params)Updates the specified IssuingCardholderobject by setting the values of the parameters passed.Cardholderupdate(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Updates the specified IssuingCardholderobject by setting the values of the parameters passed.-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
-
-
-
Method Detail
-
list
public static CardholderCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list of IssuingCardholderobjects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
list
public static CardholderCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list of IssuingCardholderobjects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
list
public static CardholderCollection list(CardholderListParams params) throws StripeException
Returns a list of IssuingCardholderobjects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
list
public static CardholderCollection list(CardholderListParams params, RequestOptions options) throws StripeException
Returns a list of IssuingCardholderobjects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
create
public static Cardholder create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Creates a new IssuingCardholderobject that can be issued cards.- Throws:
StripeException
-
create
public static Cardholder create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Creates a new IssuingCardholderobject that can be issued cards.- Throws:
StripeException
-
create
public static Cardholder create(CardholderCreateParams params) throws StripeException
Creates a new IssuingCardholderobject that can be issued cards.- Throws:
StripeException
-
create
public static Cardholder create(CardholderCreateParams params, RequestOptions options) throws StripeException
Creates a new IssuingCardholderobject that can be issued cards.- Throws:
StripeException
-
retrieve
public static Cardholder retrieve(java.lang.String cardholder) throws StripeException
Retrieves an IssuingCardholderobject.- Throws:
StripeException
-
retrieve
public static Cardholder retrieve(java.lang.String cardholder, RequestOptions options) throws StripeException
Retrieves an IssuingCardholderobject.- Throws:
StripeException
-
retrieve
public static Cardholder retrieve(java.lang.String cardholder, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves an IssuingCardholderobject.- Throws:
StripeException
-
retrieve
public static Cardholder retrieve(java.lang.String cardholder, CardholderRetrieveParams params, RequestOptions options) throws StripeException
Retrieves an IssuingCardholderobject.- Throws:
StripeException
-
update
public Cardholder update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Updates the specified IssuingCardholderobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
updatein interfaceMetadataStore<Cardholder>- Throws:
StripeException
-
update
public Cardholder update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Updates the specified IssuingCardholderobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
updatein interfaceMetadataStore<Cardholder>- Throws:
StripeException
-
update
public Cardholder update(CardholderUpdateParams params) throws StripeException
Updates the specified IssuingCardholderobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Throws:
StripeException
-
update
public Cardholder update(CardholderUpdateParams params, RequestOptions options) throws StripeException
Updates the specified IssuingCardholderobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Throws:
StripeException
-
getBilling
public Cardholder.Billing getBilling()
-
getCompany
public Cardholder.Company getCompany()
Additional information about acompanycardholder.
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getEmail
public java.lang.String getEmail()
The cardholder's email address.
-
getIndividual
public Cardholder.Individual getIndividual()
Additional information about anindividualcardholder.
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.
-
getName
public java.lang.String getName()
The cardholder's name. This will be printed on cards issued to them.
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
issuing.cardholder.
-
getPhoneNumber
public java.lang.String getPhoneNumber()
The cardholder's phone number.
-
getRequirements
public Cardholder.Requirements getRequirements()
-
getSpendingControls
public Cardholder.SpendingControls getSpendingControls()
Rules that control spending across this cardholder's cards. Refer to our documentation for more details.
-
getStatus
public java.lang.String getStatus()
Specifies whether to permit authorizations on this cardholder's cards.One of
active,blocked, orinactive.
-
getType
public java.lang.String getType()
One ofindividualorcompany.
-
setBilling
public void setBilling(Cardholder.Billing billing)
-
setCompany
public void setCompany(Cardholder.Company company)
Additional information about acompanycardholder.
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setEmail
public void setEmail(java.lang.String email)
The cardholder's email address.
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setIndividual
public void setIndividual(Cardholder.Individual individual)
Additional information about anindividualcardholder.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.
-
setMetadata
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-
setName
public void setName(java.lang.String name)
The cardholder's name. This will be printed on cards issued to them.
-
setObject
public void setObject(java.lang.String object)
String representing the object's type. Objects of the same type share the same value.Equal to
issuing.cardholder.
-
setPhoneNumber
public void setPhoneNumber(java.lang.String phoneNumber)
The cardholder's phone number.
-
setRequirements
public void setRequirements(Cardholder.Requirements requirements)
-
setSpendingControls
public void setSpendingControls(Cardholder.SpendingControls spendingControls)
Rules that control spending across this cardholder's cards. Refer to our documentation for more details.
-
setStatus
public void setStatus(java.lang.String status)
Specifies whether to permit authorizations on this cardholder's cards.One of
active,blocked, orinactive.
-
setType
public void setType(java.lang.String type)
One ofindividualorcompany.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
getId
public java.lang.String getId()
Unique identifier for the object.
-
getMetadata
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.- Specified by:
getMetadatain interfaceMetadataStore<Cardholder>
-
-