Package com.stripe.service

Class PersonService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.PersonService

public final class PersonService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
PersonService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
Person	create(String account)	Creates a new person.
Person	create(String account, RequestOptions options)	Creates a new person.
Person	create(String account, PersonCreateParams params)	Creates a new person.
Person	create(String account, PersonCreateParams params, RequestOptions options)	Creates a new person.
Person	delete(String account, String person)	Deletes an existing person’s relationship to the account’s legal entity.
Person	delete(String account, String person, RequestOptions options)	Deletes an existing person’s relationship to the account’s legal entity.
StripeCollection<Person>	list(String account)	Returns a list of people associated with the account’s legal entity.
StripeCollection<Person>	list(String account, RequestOptions options)	Returns a list of people associated with the account’s legal entity.
StripeCollection<Person>	list(String account, PersonListParams params)	Returns a list of people associated with the account’s legal entity.
StripeCollection<Person>	list(String account, PersonListParams params, RequestOptions options)	Returns a list of people associated with the account’s legal entity.
Person	retrieve(String account, String person)	Retrieves an existing person.
Person	retrieve(String account, String person, RequestOptions options)	Retrieves an existing person.
Person	retrieve(String account, String person, PersonRetrieveParams params)	Retrieves an existing person.
Person	retrieve(String account, String person, PersonRetrieveParams params, RequestOptions options)	Retrieves an existing person.
Person	update(String account, String person)	Updates an existing person.
Person	update(String account, String person, RequestOptions options)	Updates an existing person.
Person	update(String account, String person, PersonUpdateParams params)	Updates an existing person.
Person	update(String account, String person, PersonUpdateParams params, RequestOptions options)	Updates an existing person.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PersonService

public PersonService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<Person> list(String account,
 PersonListParams params)
                              throws StripeException

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Throws:

StripeException

list

public StripeCollection<Person> list(String account,
 RequestOptions options)
                              throws StripeException

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Throws:

StripeException

list

public StripeCollection<Person> list(String account)
                              throws StripeException

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Throws:

StripeException

list

public StripeCollection<Person> list(String account,
 PersonListParams params,
 RequestOptions options)
                              throws StripeException

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Throws:

StripeException

create

public Person create(String account,
 PersonCreateParams params)
              throws StripeException

Creates a new person.

Throws:

StripeException

create

public Person create(String account,
 RequestOptions options)
              throws StripeException

Creates a new person.

Throws:

StripeException

create

public Person create(String account)
              throws StripeException

Creates a new person.

Throws:

StripeException

create

public Person create(String account,
 PersonCreateParams params,
 RequestOptions options)
              throws StripeException

Creates a new person.

Throws:

StripeException

retrieve

public Person retrieve(String account,
 String person,
 PersonRetrieveParams params)
                throws StripeException

Retrieves an existing person.

Throws:

StripeException

retrieve

public Person retrieve(String account,
 String person,
 RequestOptions options)
                throws StripeException

Retrieves an existing person.

Throws:

StripeException

retrieve

public Person retrieve(String account,
 String person)
                throws StripeException

Retrieves an existing person.

Throws:

StripeException

retrieve

public Person retrieve(String account,
 String person,
 PersonRetrieveParams params,
 RequestOptions options)
                throws StripeException

Retrieves an existing person.

Throws:

StripeException

update

public Person update(String account,
 String person,
 PersonUpdateParams params)
              throws StripeException

Updates an existing person.

Throws:

StripeException

update

public Person update(String account,
 String person,
 RequestOptions options)
              throws StripeException

Updates an existing person.

Throws:

StripeException

update

public Person update(String account,
 String person)
              throws StripeException

Updates an existing person.

Throws:

StripeException

update

public Person update(String account,
 String person,
 PersonUpdateParams params,
 RequestOptions options)
              throws StripeException

Updates an existing person.

Throws:

StripeException

delete

public Person delete(String account,
 String person)
              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(String account,
 String person,
 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