The Stripe REST API. Please see https://stripe.com/docs/api for more details.
Retrieves a 3D Secure object.
Name | Data Type | Description |
---|---|---|
three_d_secure
|
string |
The identifier of the 3D Secure object to be retrieved. |
Name | Data Type | Description |
---|---|---|
expand
|
array |
Specifies which fields in the response should be expanded. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ThreeDSecure
|
object |
status
|
string |
Possible values are |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
redirect_url
|
string |
If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object
|
string Allowed values: - three_d_secure |
String representing the object's type. Objects of the same type share the same value. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
livemode
|
boolean |
Has the value |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Unique identifier for the object. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency
|
string |
Three-letter ISO currency code, in lowercase. Must be a supported currency. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created
|
integer |
Time at which the object was created. Measured in seconds since the Unix epoch. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
card
|
card | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
authenticated
|
boolean |
True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
amount
|
integer |
Initiate 3D Secure authentication.
Name | Data Type | Description |
---|---|---|
payload
|
object |
return_url
|
string |
The URL that the cardholder's browser will be returned to when authentication completes. |
expand
|
array [string] |
Specifies which fields in the response should be expanded. |
customer
|
string | |
currency
|
string |
Three-letter ISO currency code, in lowercase. Must be a supported currency. |
card
|
string |
The ID of a card token, or the ID of a card belonging to the given customer. |
amount
|
integer |
Amount of the charge that you will create when authentication completes. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ThreeDSecure
|
object |
status
|
string |
Possible values are |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
redirect_url
|
string |
If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object
|
string Allowed values: - three_d_secure |
String representing the object's type. Objects of the same type share the same value. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
livemode
|
boolean |
Has the value |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Unique identifier for the object. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency
|
string |
Three-letter ISO currency code, in lowercase. Must be a supported currency. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created
|
integer |
Time at which the object was created. Measured in seconds since the Unix epoch. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
card
|
card | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
authenticated
|
boolean |
True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
amount
|
integer |
Delete a specified external account for a given account.
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of the external account to be deleted. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Polymorphic
|
object |
object
|
string Allowed values: - bank_account |
String representing the object's type. Objects of the same type share the same value. |
id
|
string |
Unique identifier for the object. |
deleted
|
boolean Allowed values: - 1 |
Always true for a deleted object |
currency
|
string |
Three-letter ISO code for the currency paid out to the bank account. |
Retrieve a specified external account for a given account.
Name | Data Type | Description |
---|---|---|
id
|
string |
Name | Data Type | Description |
---|---|---|
expand
|
array |
Specifies which fields in the response should be expanded. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Polymorphic
|
object |
object
|
string Allowed values: - bank_account |
String representing the object's type. Objects of the same type share the same value. |
metadata
|
object |
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. |
last4
|
string | |
id
|
string |
Unique identifier for the object. |
fingerprint
|
string |
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. |
default_for_currency
|
boolean |
Whether this bank account is the default external account for its currency. |
customer
|
string | |
currency
|
string |
Three-letter ISO code for the currency paid out to the bank account. |
country
|
string |
Two-letter ISO code representing the country the bank account is located in. |
account
|
string |
Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.
You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of the external account to update |
Name | Data Type | Description |
---|---|---|
payload
|
object |
name
|
string |
Cardholder name. |
metadata
|
object | |
expand
|
array [string] |
Specifies which fields in the response should be expanded. |
exp_year
|
string |
Four digit number representing the card’s expiration year. |
exp_month
|
string |
Two digit number representing the card’s expiration month. |
default_for_currency
|
boolean |
When set to true, this becomes the default external account for its currency. |
address_zip
|
string |
ZIP or postal code. |
address_state
|
string |
State/County/Province/Region. |
address_line2
|
string |
Address line 2 (Apartment/Suite/Unit/Building). |
address_line1
|
string |
Address line 1 (Street address/PO Box/Company name). |
address_country
|
string |
Billing address country, if provided when creating card. |
address_city
|
string |
City/District/Suburb/Town/Village. |
account_holder_type
|
string Allowed values: -
- company - individual |
The type of entity that holds the account. This can be either |
account_holder_name
|
string |
The name of the person or business that owns the bank account. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Polymorphic
|
object |
object
|
string Allowed values: - bank_account |
String representing the object's type. Objects of the same type share the same value. |
metadata
|
object |
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. |
last4
|
string | |
id
|
string |
Unique identifier for the object. |
fingerprint
|
string |
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. |
default_for_currency
|
boolean |
Whether this bank account is the default external account for its currency. |
customer
|
string | |
currency
|
string |
Three-letter ISO code for the currency paid out to the bank account. |
country
|
string |
Two-letter ISO code representing the country the bank account is located in. |
account
|
string |
Create an external account for a given account.
Name | Data Type | Description |
---|---|---|
payload
|
object |
metadata
|
object |
A set of key-value pairs that you can attach to an external account object. It can be useful for storing additional information about the external account in a structured format. |
external_account
|
This string to be replaced by DocSpecGenerator. |
|
expand
|
array [string] |
Specifies which fields in the response should be expanded. |
default_for_currency
|
boolean |
When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. |
bank_account
|
Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Polymorphic
|
object |
object
|
string Allowed values: - bank_account |
String representing the object's type. Objects of the same type share the same value. |
metadata
|
object |
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. |
last4
|
string | |
id
|
string |
Unique identifier for the object. |
fingerprint
|
string |
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. |
default_for_currency
|
boolean |
Whether this bank account is the default external account for its currency. |
customer
|
string | |
currency
|
string |
Three-letter ISO code for the currency paid out to the bank account. |
country
|
string |
Two-letter ISO code representing the country the bank account is located in. |
account
|
string |
Delete a specified external account for a given account.
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of the external account to be deleted. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Polymorphic
|
object |
object
|
string Allowed values: - bank_account |
String representing the object's type. Objects of the same type share the same value. |
id
|
string |
Unique identifier for the object. |
deleted
|
boolean Allowed values: - 1 |
Always true for a deleted object |
currency
|
string |
Three-letter ISO code for the currency paid out to the bank account. |
Retrieve a specified external account for a given account.
Name | Data Type | Description |
---|---|---|
id
|
string |
Name | Data Type | Description |
---|---|---|
expand
|
array |
Specifies which fields in the response should be expanded. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Polymorphic
|
object |
object
|
string Allowed values: - bank_account |
String representing the object's type. Objects of the same type share the same value. |
metadata
|
object |
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. |
last4
|
string | |
id
|
string |
Unique identifier for the object. |
fingerprint
|
string |
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. |
default_for_currency
|
boolean |
Whether this bank account is the default external account for its currency. |
customer
|
string | |
currency
|
string |
Three-letter ISO code for the currency paid out to the bank account. |
country
|
string |
Two-letter ISO code representing the country the bank account is located in. |
account
|
string |
Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.
You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of the external account to update |
Name | Data Type | Description |
---|---|---|
payload
|
object |
name
|
string |
Cardholder name. |
metadata
|
object | |
expand
|
array [string] |
Specifies which fields in the response should be expanded. |
exp_year
|
string |
Four digit number representing the card’s expiration year. |
exp_month
|
string |
Two digit number representing the card’s expiration month. |
default_for_currency
|
boolean |
When set to true, this becomes the default external account for its currency. |
address_zip
|
string |
ZIP or postal code. |
address_state
|
string |
State/County/Province/Region. |
address_line2
|
string |
Address line 2 (Apartment/Suite/Unit/Building). |
address_line1
|
string |
Address line 1 (Street address/PO Box/Company name). |
address_country
|
string |
Billing address country, if provided when creating card. |
address_city
|
string |
City/District/Suburb/Town/Village. |
account_holder_type
|
string Allowed values: -
- company - individual |
The type of entity that holds the account. This can be either |
account_holder_name
|
string |
The name of the person or business that owns the bank account. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Polymorphic
|
object |
object
|
string Allowed values: - bank_account |
String representing the object's type. Objects of the same type share the same value. |
metadata
|
object |
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. |
last4
|
string | |
id
|
string |
Unique identifier for the object. |
fingerprint
|
string |
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. |
default_for_currency
|
boolean |
Whether this bank account is the default external account for its currency. |
customer
|
string | |
currency
|
string |
Three-letter ISO code for the currency paid out to the bank account. |
country
|
string |
Two-letter ISO code representing the country the bank account is located in. |
account
|
string |
List external accounts for an account.
Name | Data Type | Description |
---|---|---|
starting_after
|
string |
A cursor for use in pagination. |
limit
|
integer |
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
ending_before
|
string |
A cursor for use in pagination. |
expand
|
array |
Specifies which fields in the response should be expanded. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ExternalAccountList
|
object |
url
|
string |
The URL where this list can be accessed. |
|||||||||||||||||||||||||||||||||||||||||||||||||
object
|
string Allowed values: - list |
String representing the object's type. Objects of the same type share the same value. Always has the value |
|||||||||||||||||||||||||||||||||||||||||||||||||
has_more
|
boolean |
True if this list has another page of items after this one that can be fetched. |
|||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [bank_account] |
The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. |
|||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Create an external account for a given account.
Name | Data Type | Description |
---|---|---|
payload
|
object |
metadata
|
object |
A set of key-value pairs that you can attach to an external account object. It can be useful for storing additional information about the external account in a structured format. |
external_account
|
This string to be replaced by DocSpecGenerator. |
|
expand
|
array [string] |
Specifies which fields in the response should be expanded. |
default_for_currency
|
boolean |
When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. |
bank_account
|
Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Polymorphic
|
object |
object
|
string Allowed values: - bank_account |
String representing the object's type. Objects of the same type share the same value. |
metadata
|
object |
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. |
last4
|
string | |
id
|
string |
Unique identifier for the object. |
fingerprint
|
string |
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. |
default_for_currency
|
boolean |
Whether this bank account is the default external account for its currency. |
customer
|
string | |
currency
|
string |
Three-letter ISO code for the currency paid out to the bank account. |
country
|
string |
Two-letter ISO code representing the country the bank account is located in. |
account
|
string |
Creates a single-use login link for an Express account to access their Stripe dashboard.
You may only create login links for Express accounts connected to your platform.
Name | Data Type | Description |
---|---|---|
payload
|
object |
redirect_url
|
string |
Where to redirect the user after they log out of their dashboard. |
expand
|
array [string] |
Specifies which fields in the response should be expanded. |
account
|
string |
The identifier of the account to create a login link for. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
LoginLink
|
object |
url
|
string |
The URL for the login link. |
object
|
string Allowed values: - login_link |
String representing the object's type. Objects of the same type share the same value. |
created
|
integer |
Time at which the object was created. Measured in seconds since the Unix epoch. |
Invalidates all sessions for a light account, for a platform to use during platform logout.
You may only log out Express accounts connected to your platform.
Name | Data Type | Description |
---|---|---|
payload
|
object |
expand
|
array [string] |
Specifies which fields in the response should be expanded. |
account
|
string |
The identifier of the account to log out. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
LightAccountLogout
|
object |
Deletes an existing person’s relationship to the account’s legal entity.
Name | Data Type | Description |
---|---|---|
person
|
string |
The ID of the person to be deleted. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DeletedPerson
|
object |
object
|
string Allowed values: - person |
String representing the object's type. Objects of the same type share the same value. |
id
|
string |
Unique identifier for the object. |
deleted
|
boolean Allowed values: - 1 |
Always true for a deleted object |
Retrieves an existing person.
Name | Data Type | Description |
---|---|---|
person
|
string |
The ID of a person to retrieve. |
Name | Data Type | Description |
---|---|---|
expand
|
array |
Specifies which fields in the response should be expanded. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Person
|
object |
verification
|
legal_entity_verification | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
ssn_last_4_provided
|
boolean |
Whether the last 4 digits of this person's SSN have been provided. |
|||||||||||||||||||||||||
requirements
|
person_requirements | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
relationship
|
person_relationship | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
phone
|
string |
The person's phone number. |
|||||||||||||||||||||||||
object
|
string Allowed values: - person |
String representing the object's type. Objects of the same type share the same value. |
|||||||||||||||||||||||||
metadata
|
object |
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. |
|||||||||||||||||||||||||
maiden_name
|
string |
The person's maiden name. |
|||||||||||||||||||||||||
last_name_kanji
|
string |
The Kanji variation of the person's last name (Japan only). |
|||||||||||||||||||||||||
last_name_kana
|
string |
The Kana variation of the person's last name (Japan only). |
|||||||||||||||||||||||||
last_name
|
string |
The person's last name. |
|||||||||||||||||||||||||
id_number_provided
|
boolean |
Whether the person's |
|||||||||||||||||||||||||
id
|
string |
Unique identifier for the object. |
|||||||||||||||||||||||||
gender
|
string |
The person's gender (International regulations require either "male" or "female"). |
|||||||||||||||||||||||||
first_name_kanji
|
string |
The Kanji variation of the person's first name (Japan only). |
|||||||||||||||||||||||||
first_name_kana
|
string |
The Kana variation of the person's first name (Japan only). |
|||||||||||||||||||||||||
first_name
|
string |
The person's first name. |
|||||||||||||||||||||||||
email
|
string |
The person's email address. |
|||||||||||||||||||||||||
dob
|
legal_entity_dob | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
created
|
integer |
Time at which the object was created. Measured in seconds since the Unix epoch. |
|||||||||||||||||||||||||
address_kanji
|
legal_entity_japan_address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
address_kana
|
legal_entity_japan_address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
address
|
address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
account
|
string |
The account the person is associated with. |
Updates an existing person.
Name | Data Type | Description |
---|---|---|
person
|
string |
The ID of a person to update. |
Name | Data Type | Description |
---|---|---|
payload
|
object |
ssn_last_4
|
string |
The last 4 digits of the person's social security number. |
relationship
|
||
phone
|
string |
The person's phone number. |
metadata
|
object |
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
maiden_name
|
string |
The person's maiden name. |
last_name_kanji
|
string |
The Kanji variation of the person's last name (Japan only). |
last_name_kana
|
string |
The Kana variation of the person's last name (Japan only). |
last_name
|
string |
The person's last name. |
id_number
|
string |
The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. |
gender
|
string |
The person's gender (International regulations require either "male" or "female"). |
first_name_kanji
|
string |
The Kanji variation of the person's first name (Japan only). |
first_name_kana
|
string |
The Kana variation of the person's first name (Japan only). |
first_name
|
string |
The person's first name. |
expand
|
array [string] |
Specifies which fields in the response should be expanded. |
email
|
string |
The person's email address. |
dob
|
||
address_kanji
|
||
address_kana
|
||
address
|
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Person
|
object |
verification
|
legal_entity_verification | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
ssn_last_4_provided
|
boolean |
Whether the last 4 digits of this person's SSN have been provided. |
|||||||||||||||||||||||||
requirements
|
person_requirements | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
relationship
|
person_relationship | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
phone
|
string |
The person's phone number. |
|||||||||||||||||||||||||
object
|
string Allowed values: - person |
String representing the object's type. Objects of the same type share the same value. |
|||||||||||||||||||||||||
metadata
|
object |
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. |
|||||||||||||||||||||||||
maiden_name
|
string |
The person's maiden name. |
|||||||||||||||||||||||||
last_name_kanji
|
string |
The Kanji variation of the person's last name (Japan only). |
|||||||||||||||||||||||||
last_name_kana
|
string |
The Kana variation of the person's last name (Japan only). |
|||||||||||||||||||||||||
last_name
|
string |
The person's last name. |
|||||||||||||||||||||||||
id_number_provided
|
boolean |
Whether the person's |
|||||||||||||||||||||||||
id
|
string |
Unique identifier for the object. |
|||||||||||||||||||||||||
gender
|
string |
The person's gender (International regulations require either "male" or "female"). |
|||||||||||||||||||||||||
first_name_kanji
|
string |
The Kanji variation of the person's first name (Japan only). |
|||||||||||||||||||||||||
first_name_kana
|
string |
The Kana variation of the person's first name (Japan only). |
|||||||||||||||||||||||||
first_name
|
string |
The person's first name. |
|||||||||||||||||||||||||
email
|
string |
The person's email address. |
|||||||||||||||||||||||||
dob
|
legal_entity_dob | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
created
|
integer |
Time at which the object was created. Measured in seconds since the Unix epoch. |
|||||||||||||||||||||||||
address_kanji
|
legal_entity_japan_address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
address_kana
|
legal_entity_japan_address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
address
|
address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
account
|
string |
The account the person is associated with. |
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.
Name | Data Type | Description |
---|---|---|
starting_after
|
string |
A cursor for use in pagination. |
relationship
|
string |
Filters on the list of people returned based on the person's relationship to the account's company. |
limit
|
integer |
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
ending_before
|
string |
A cursor for use in pagination. |
expand
|
array |
Specifies which fields in the response should be expanded. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
body
|
object |
url
|
string |
The URL where this list can be accessed. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object
|
string Allowed values: - list |
String representing the object's type. Objects of the same type share the same value. Always has the value |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
has_more
|
boolean |
True if this list has another page of items after this one that can be fetched. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [person] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Creates a new person.
Name | Data Type | Description |
---|---|---|
payload
|
object |
ssn_last_4
|
string |
The last 4 digits of the person's social security number. |
relationship
|
||
phone
|
string |
The person's phone number. |
metadata
|
object |
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
maiden_name
|
string |
The person's maiden name. |
last_name_kanji
|
string |
The Kanji variation of the person's last name (Japan only). |
last_name_kana
|
string |
The Kana variation of the person's last name (Japan only). |
last_name
|
string |
The person's last name. |
id_number
|
string |
The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. |
gender
|
string |
The person's gender (International regulations require either "male" or "female"). |
first_name_kanji
|
string |
The Kanji variation of the person's first name (Japan only). |
first_name_kana
|
string |
The Kana variation of the person's first name (Japan only). |
first_name
|
string |
The person's first name. |
expand
|
array [string] |
Specifies which fields in the response should be expanded. |
email
|
string |
The person's email address. |
dob
|
||
address_kanji
|
||
address_kana
|
||
address
|
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Person
|
object |
verification
|
legal_entity_verification | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
ssn_last_4_provided
|
boolean |
Whether the last 4 digits of this person's SSN have been provided. |
|||||||||||||||||||||||||
requirements
|
person_requirements | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
relationship
|
person_relationship | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
phone
|
string |
The person's phone number. |
|||||||||||||||||||||||||
object
|
string Allowed values: - person |
String representing the object's type. Objects of the same type share the same value. |
|||||||||||||||||||||||||
metadata
|
object |
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. |
|||||||||||||||||||||||||
maiden_name
|
string |
The person's maiden name. |
|||||||||||||||||||||||||
last_name_kanji
|
string |
The Kanji variation of the person's last name (Japan only). |
|||||||||||||||||||||||||
last_name_kana
|
string |
The Kana variation of the person's last name (Japan only). |
|||||||||||||||||||||||||
last_name
|
string |
The person's last name. |
|||||||||||||||||||||||||
id_number_provided
|
boolean |
Whether the person's |
|||||||||||||||||||||||||
id
|
string |
Unique identifier for the object. |
|||||||||||||||||||||||||
gender
|
string |
The person's gender (International regulations require either "male" or "female"). |
|||||||||||||||||||||||||
first_name_kanji
|
string |
The Kanji variation of the person's first name (Japan only). |
|||||||||||||||||||||||||
first_name_kana
|
string |
The Kana variation of the person's first name (Japan only). |
|||||||||||||||||||||||||
first_name
|
string |
The person's first name. |
|||||||||||||||||||||||||
email
|
string |
The person's email address. |
|||||||||||||||||||||||||
dob
|
legal_entity_dob | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
created
|
integer |
Time at which the object was created. Measured in seconds since the Unix epoch. |
|||||||||||||||||||||||||
address_kanji
|
legal_entity_japan_address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
address_kana
|
legal_entity_japan_address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
address
|
address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
account
|
string |
The account the person is associated with. |
Deletes an existing person’s relationship to the account’s legal entity.
Name | Data Type | Description |
---|---|---|
person
|
string |
The ID of the person to be deleted. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DeletedPerson
|
object |
object
|
string Allowed values: - person |
String representing the object's type. Objects of the same type share the same value. |
id
|
string |
Unique identifier for the object. |
deleted
|
boolean Allowed values: - 1 |
Always true for a deleted object |
Retrieves an existing person.
Name | Data Type | Description |
---|---|---|
person
|
string |
The ID of a person to retrieve. |
Name | Data Type | Description |
---|---|---|
expand
|
array |
Specifies which fields in the response should be expanded. |
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Person
|
object |
verification
|
legal_entity_verification | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
ssn_last_4_provided
|
boolean |
Whether the last 4 digits of this person's SSN have been provided. |
|||||||||||||||||||||||||
requirements
|
person_requirements | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
relationship
|
person_relationship | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
phone
|
string |
The person's phone number. |
|||||||||||||||||||||||||
object
|
string Allowed values: - person |
String representing the object's type. Objects of the same type share the same value. |
|||||||||||||||||||||||||
metadata
|
object |
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. |
|||||||||||||||||||||||||
maiden_name
|
string |
The person's maiden name. |
|||||||||||||||||||||||||
last_name_kanji
|
string |
The Kanji variation of the person's last name (Japan only). |
|||||||||||||||||||||||||
last_name_kana
|
string |
The Kana variation of the person's last name (Japan only). |
|||||||||||||||||||||||||
last_name
|
string |
The person's last name. |
|||||||||||||||||||||||||
id_number_provided
|
boolean |
Whether the person's |
|||||||||||||||||||||||||
id
|
string |
Unique identifier for the object. |
|||||||||||||||||||||||||
gender
|
string |
The person's gender (International regulations require either "male" or "female"). |
|||||||||||||||||||||||||
first_name_kanji
|
string |
The Kanji variation of the person's first name (Japan only). |
|||||||||||||||||||||||||
first_name_kana
|
string |
The Kana variation of the person's first name (Japan only). |
|||||||||||||||||||||||||
first_name
|
string |
The person's first name. |
|||||||||||||||||||||||||
email
|
string |
The person's email address. |
|||||||||||||||||||||||||
dob
|
legal_entity_dob | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
created
|
integer |
Time at which the object was created. Measured in seconds since the Unix epoch. |
|||||||||||||||||||||||||
address_kanji
|
legal_entity_japan_address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
address_kana
|
legal_entity_japan_address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
address
|
address | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
account
|
string |
The account the person is associated with. |
Updates an existing person.
Name | Data Type | Description |
---|---|---|
person
|
string |
The ID of a person to update. |
Name | Data Type | Description |
---|---|---|
payload
|
object |
ssn_last_4
|
string |
The last 4 digits of the person's social security number. |
relationship
|
||
phone
|
string |
The person's phone number. |
metadata
|
object |
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
maiden_name
|
string |
The person's maiden name. |
last_name_kanji
|
string |
The Kanji variation of the person's last name (Japan only). |
last_name_kana
|
string |
The Kana variation of the person's last name (Japan only). |
last_name
|
string |
The person's last name. |
id_number
|
string |
The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. |
gender
|
string |
The person's gender (International regulations require either "male" or "female"). |
first_name_kanji
|
string |
The Kanji variation of the person's first name (Japan only). |
first_name_kana
|
string |
The Kana variation of the person's first name (Japan only). |
first_name
|
string |
The person's first name. |
expand
|
array [string] |
Specifies which fields in the response should be expanded. |
email
|
string |
The person's email address. |
dob
|
||
address_kanji
|
||
address_kana
|
||
address
|
Name | Data Type | Description |
---|---|---|
error
|
object |
An error response from the Stripe API |
error
|
api_errors | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|