Person (stripe-java 16.7.0 API)

java.lang.Object
- com.stripe.model.StripeObject
- - com.stripe.net.ApiResource
  - - com.stripe.model.Person

All Implemented Interfaces:: HasId, MetadataStore<Person>

public class Person
extends ApiResource
implements HasId, MetadataStore<Person>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Person.DateOfBirth`
`static class`	`Person.JapanAddress`
`static class`	`Person.Relationship`
`static class`	`Person.Requirements`
`static class`	`Person.Verification`
`static class`	`Person.VerificationDocument`

Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod, ApiResource.RequestType

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 and Description

Person()

Constructors
Constructor and Description
`Person()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`Person`	`delete()` Deletes an existing person’s relationship to the account’s legal entity.
`Person`	`delete(java.util.Map<java.lang.String,java.lang.Object> params)` Deletes an existing person’s relationship to the account’s legal entity.
`Person`	`delete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Deletes an existing person’s relationship to the account’s legal entity.
`Person`	`delete(RequestOptions options)` Deletes an existing person’s relationship to the account’s legal entity.
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getAccount()` The account the person is associated with.
`Address`	`getAddress()`
`Person.JapanAddress`	`getAddressKana()` The Kana variation of the person's address (Japan only).
`Person.JapanAddress`	`getAddressKanji()` The Kanji variation of the person's address (Japan only).
`java.lang.Long`	`getCreated()` Time at which the object was created.
`java.lang.Boolean`	`getDeleted()` Always true for a deleted object.
`Person.DateOfBirth`	`getDob()`
`java.lang.String`	`getEmail()` The person's email address.
`java.lang.String`	`getFirstName()` The person's first name.
`java.lang.String`	`getFirstNameKana()` The Kana variation of the person's first name (Japan only).
`java.lang.String`	`getFirstNameKanji()` The Kanji variation of the person's first name (Japan only).
`java.lang.String`	`getGender()` The person's gender (International regulations require either "male" or "female").
`java.lang.String`	`getId()` Unique identifier for the object.
`java.lang.Boolean`	`getIdNumberProvided()` Whether the person's `id_number` was provided.
`java.lang.String`	`getLastName()` The person's last name.
`java.lang.String`	`getLastNameKana()` The Kana variation of the person's last name (Japan only).
`java.lang.String`	`getLastNameKanji()` The Kanji variation of the person's last name (Japan only).
`java.lang.String`	`getMaidenName()` The person's maiden name.
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Set of key-value pairs that you can attach to an object.
`java.lang.String`	`getObject()` String representing the object's type.
`java.lang.String`	`getPhone()` The person's phone number.
`Person.Relationship`	`getRelationship()`
`Person.Requirements`	`getRequirements()` Information about the requirements for this person, including what information needs to be collected, and by when.
`java.lang.Boolean`	`getSsnLast4Provided()` Whether the last 4 digits of this person's SSN have been provided.
`Person.Verification`	`getVerification()`
`int`	`hashCode()`
`void`	`setAccount(java.lang.String account)` The account the person is associated with.
`void`	`setAddress(Address address)`
`void`	`setAddressKana(Person.JapanAddress addressKana)` The Kana variation of the person's address (Japan only).
`void`	`setAddressKanji(Person.JapanAddress addressKanji)` The Kanji variation of the person's address (Japan only).
`void`	`setCreated(java.lang.Long created)` Time at which the object was created.
`void`	`setDeleted(java.lang.Boolean deleted)` Always true for a deleted object.
`void`	`setDob(Person.DateOfBirth dob)`
`void`	`setEmail(java.lang.String email)` The person's email address.
`void`	`setFirstName(java.lang.String firstName)` The person's first name.
`void`	`setFirstNameKana(java.lang.String firstNameKana)` The Kana variation of the person's first name (Japan only).
`void`	`setFirstNameKanji(java.lang.String firstNameKanji)` The Kanji variation of the person's first name (Japan only).
`void`	`setGender(java.lang.String gender)` The person's gender (International regulations require either "male" or "female").
`void`	`setId(java.lang.String id)` Unique identifier for the object.
`void`	`setIdNumberProvided(java.lang.Boolean idNumberProvided)` Whether the person's `id_number` was provided.
`void`	`setLastName(java.lang.String lastName)` The person's last name.
`void`	`setLastNameKana(java.lang.String lastNameKana)` The Kana variation of the person's last name (Japan only).
`void`	`setLastNameKanji(java.lang.String lastNameKanji)` The Kanji variation of the person's last name (Japan only).
`void`	`setMaidenName(java.lang.String maidenName)` The person's maiden name.
`void`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)` Set of key-value pairs that you can attach to an object.
`void`	`setObject(java.lang.String object)` String representing the object's type.
`void`	`setPhone(java.lang.String phone)` The person's phone number.
`void`	`setRelationship(Person.Relationship relationship)`
`void`	`setRequirements(Person.Requirements requirements)` Information about the requirements for this person, including what information needs to be collected, and by when.
`void`	`setSsnLast4Provided(java.lang.Boolean ssnLast4Provided)` Whether the last 4 digits of this person's SSN have been provided.
`void`	`setVerification(Person.Verification verification)`
`Person`	`update(java.util.Map<java.lang.String,java.lang.Object> params)` Updates an existing person.
`Person`	`update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Updates an existing person.
`Person`	`update(PersonUpdateParams params)` Updates an existing person.
`Person`	`update(PersonUpdateParams params, RequestOptions options)` Updates an existing person.

Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, multipartRequest, 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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Person
```
public Person()
```
- Method Detail
  - update
```
public Person update(java.util.Map<java.lang.String,java.lang.Object> params)
              throws StripeException
```
    Updates an existing person.
    
    Specified by:
    
    update in interface MetadataStore<Person>
    
    Throws:
    
    StripeException
  - update
```
public Person update(java.util.Map<java.lang.String,java.lang.Object> params,
                     RequestOptions options)
              throws StripeException
```
    Updates an existing person.
    
    Specified by:
    
    update in interface MetadataStore<Person>
    
    Throws:
    
    StripeException
  - update
```
public Person update(PersonUpdateParams params)
              throws StripeException
```
    Updates an existing person.
    
    Throws:
    
    StripeException
  - update
```
public Person update(PersonUpdateParams params,
                     RequestOptions options)
              throws StripeException
```
    Updates an existing person.
    
    Throws:
    
    StripeException
  - delete
```
public Person delete()
              throws StripeException
```
    Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
    
    Throws:
    
    StripeException
  - delete
```
public Person delete(RequestOptions options)
              throws StripeException
```
    Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
    
    Throws:
    
    StripeException
  - delete
```
public Person delete(java.util.Map<java.lang.String,java.lang.Object> params)
              throws StripeException
```
    Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
    
    Throws:
    
    StripeException
  - delete
```
public Person delete(java.util.Map<java.lang.String,java.lang.Object> params,
                     RequestOptions options)
              throws StripeException
```
    Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
    
    Throws:
    
    StripeException
  - getAccount
```
public java.lang.String getAccount()
```
    The account the person is associated with.
  - getAddress
```
public Address getAddress()
```
  - getAddressKana
```
public Person.JapanAddress getAddressKana()
```
    The Kana variation of the person's address (Japan only).
  - getAddressKanji
```
public Person.JapanAddress getAddressKanji()
```
    The Kanji variation of the person's address (Japan only).
  - getCreated
```
public java.lang.Long getCreated()
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - getDeleted
```
public java.lang.Boolean getDeleted()
```
    Always true for a deleted object.
  - getDob
```
public Person.DateOfBirth getDob()
```
  - getEmail
```
public java.lang.String getEmail()
```
    The person's email address.
  - getFirstName
```
public java.lang.String getFirstName()
```
    The person's first name.
  - getFirstNameKana
```
public java.lang.String getFirstNameKana()
```
    The Kana variation of the person's first name (Japan only).
  - getFirstNameKanji
```
public java.lang.String getFirstNameKanji()
```
    The Kanji variation of the person's first name (Japan only).
  - getGender
```
public java.lang.String getGender()
```
    The person's gender (International regulations require either "male" or "female").
  - getIdNumberProvided
```
public java.lang.Boolean getIdNumberProvided()
```
    Whether the person's `id_number` was provided.
  - getLastName
```
public java.lang.String getLastName()
```
    The person's last name.
  - getLastNameKana
```
public java.lang.String getLastNameKana()
```
    The Kana variation of the person's last name (Japan only).
  - getLastNameKanji
```
public java.lang.String getLastNameKanji()
```
    The Kanji variation of the person's last name (Japan only).
  - getMaidenName
```
public java.lang.String getMaidenName()
```
    The person's maiden name.
  - getObject
```
public java.lang.String getObject()
```
    String representing the object's type. Objects of the same type share the same value.
    Equal to `person`.
  - getPhone
```
public java.lang.String getPhone()
```
    The person's phone number.
  - getRelationship
```
public Person.Relationship getRelationship()
```
  - getRequirements
```
public Person.Requirements getRequirements()
```
    Information about the requirements for this person, including what information needs to be collected, and by when.
  - getSsnLast4Provided
```
public java.lang.Boolean getSsnLast4Provided()
```
    Whether the last 4 digits of this person's SSN have been provided.
  - getVerification
```
public Person.Verification getVerification()
```
  - setAccount
```
public void setAccount(java.lang.String account)
```
    The account the person is associated with.
  - setAddress
```
public void setAddress(Address address)
```
  - setAddressKana
```
public void setAddressKana(Person.JapanAddress addressKana)
```
    The Kana variation of the person's address (Japan only).
  - setAddressKanji
```
public void setAddressKanji(Person.JapanAddress addressKanji)
```
    The Kanji variation of the person's address (Japan only).
  - setCreated
```
public void setCreated(java.lang.Long created)
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - setDeleted
```
public void setDeleted(java.lang.Boolean deleted)
```
    Always true for a deleted object.
  - setDob
```
public void setDob(Person.DateOfBirth dob)
```
  - setEmail
```
public void setEmail(java.lang.String email)
```
    The person's email address.
  - setFirstName
```
public void setFirstName(java.lang.String firstName)
```
    The person's first name.
  - setFirstNameKana
```
public void setFirstNameKana(java.lang.String firstNameKana)
```
    The Kana variation of the person's first name (Japan only).
  - setFirstNameKanji
```
public void setFirstNameKanji(java.lang.String firstNameKanji)
```
    The Kanji variation of the person's first name (Japan only).
  - setGender
```
public void setGender(java.lang.String gender)
```
    The person's gender (International regulations require either "male" or "female").
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier for the object.
  - setIdNumberProvided
```
public void setIdNumberProvided(java.lang.Boolean idNumberProvided)
```
    Whether the person's `id_number` was provided.
  - setLastName
```
public void setLastName(java.lang.String lastName)
```
    The person's last name.
  - setLastNameKana
```
public void setLastNameKana(java.lang.String lastNameKana)
```
    The Kana variation of the person's last name (Japan only).
  - setLastNameKanji
```
public void setLastNameKanji(java.lang.String lastNameKanji)
```
    The Kanji variation of the person's last name (Japan only).
  - setMaidenName
```
public void setMaidenName(java.lang.String maidenName)
```
    The person's maiden name.
  - 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.
  - 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 `person`.
  - setPhone
```
public void setPhone(java.lang.String phone)
```
    The person's phone number.
  - setRelationship
```
public void setRelationship(Person.Relationship relationship)
```
  - setRequirements
```
public void setRequirements(Person.Requirements requirements)
```
    Information about the requirements for this person, including what information needs to be collected, and by when.
  - setSsnLast4Provided
```
public void setSsnLast4Provided(java.lang.Boolean ssnLast4Provided)
```
    Whether the last 4 digits of this person's SSN have been provided.
  - setVerification
```
public void setVerification(Person.Verification verification)
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getId
```
public java.lang.String getId()
```
    Unique identifier for the object.
    
    Specified by:
    
    getId in interface HasId
  - 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:
    
    getMetadata in interface MetadataStore<Person>

Class Person

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

Field Summary

Fields inherited from class com.stripe.net.ApiResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.ApiResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

Person

Method Detail

update

update

update

update

delete

delete

delete

delete

getAccount

getAddress

getAddressKana

getAddressKanji

getCreated

getDeleted

getDob

getEmail

getFirstName

getFirstNameKana

getFirstNameKanji

getGender

getIdNumberProvided

getLastName

getLastNameKana

getLastNameKanji

getMaidenName

getObject

getPhone

getRelationship

getRequirements

getSsnLast4Provided

getVerification

setAccount

setAddress

setAddressKana

setAddressKanji

setCreated

setDeleted

setDob

setEmail

setFirstName

setFirstNameKana

setFirstNameKanji

setGender

setId

setIdNumberProvided

setLastName

setLastNameKana

setLastNameKanji

setMaidenName

setMetadata

setObject

setPhone

setRelationship

setRequirements

setSsnLast4Provided

setVerification

equals

canEqual

hashCode

getId

getMetadata