Accounts
Create, update, delete, and query the Accounts you manage in Stripe.
Table Specific Information
Select
Server-Side Query Support
The add-in uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the add-in.
- Id support the following operator: =.
- Created supports the following operators: <, >, >=, <, <= , =.
- AccountId supports the following operator: =.
You can select:
An account by specifying its Id:
SELECT * FROM Accounts WHERE Id = 'MyId'
Accounts created after a specific date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):
SELECT * FROM Accounts WHERE Created = '2018-11-16 10:59:00.0'
Insert
To create a new account, you must provide an email address if the Managed field is not set or is false, and you must include Capabilities.
Capabilities is an aggregate column. Review the following example on how to insert into this column:
INSERT INTO Accounts (IndividualFullNameAliases, Country, Email, Type, BusinessType, CapabilitiesTransfers) VALUES ('[\"alias1\",\"alias2\"]','US','[email protected]','custom','individual','{\"requested\":\"true\"}')
Update
To update an account, specify the Id of the account:
UPDATE Accounts SET BusinessType='company' WHERE Id = 'acct_1OPti7GbN1KxSEes'
Delete
To delete an account, specify the Id of the account:
DELETE FROM Accounts WHERE Id = 'acct_1A0XVyFF36eOzuU5'
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
The unique identifier for the account. | |
BusinessType | String | False |
The business type of company The allowed values are individual, company, non_profit, government_entity. | |
ChargesEnabled | Boolean | True |
Whether or not the account can create live charges. | |
Country | String | False |
The country of the account. | |
IsController | Boolean | True |
Whether or not the Connect application retrieving the resource controls the account. | |
ControllerType | String | True |
The controller type. | |
Created | Datetime | True |
Time at which the account was connected. | |
DefaultCurrency | String | False |
The currency this account has chosen to use as the default. | |
DetailsSubmitted | Boolean | True |
Whether or not account details have been submitted yet. Standalone accounts cannot receive transfers before this is true. | |
String | False |
The primary email address of the user. | ||
ExternalAccountsAggregate | String | True |
External accounts (bank accounts and/or cards) currently attached to this account. | |
FutureRequirementsAggregate | String | True |
Information about the upcoming new requirements for the account, including what information needs to be collected, and by when. | |
PayoutsEnabled | Boolean | True |
Whether Stripe can send payouts to this account. | |
SettingsAggregate | String | True |
Options for customizing how the account functions within Stripe. | |
BusinessProfileSupportEmail | String | False |
The publicly shareable email address that can be reached for support for this account. | |
BusinessProfileSupportPhone | String | False |
The publicly visible support phone number for the business. | |
BusinessProfileSupportAddressCity | String | False |
City, district, suburb, town, or village. | |
BusinessProfileSupportAddressCountry | String | False |
Two-letter country code. | |
BusinessProfileSupportAddressLine1 | String | False |
Address line 1 (e.g., street, PO Box, or company name). | |
BusinessProfileSupportAddressLine2 | String | False |
Address line 2 (e.g., apartment, suite, unit, or building). | |
BusinessProfileSupportAddressPostalCode | String | False |
ZIP or postal code. | |
BusinessProfileSupportAddressState | String | False |
State, county, province, or region. | |
BusinessProfileSupportUrl | String | False |
The publicly shareable URL that can be reached for support for this account | |
BusinessProfileProductDescription | String | False |
An internal-only description of the product or service provided. This is used by Stripe in the event the account gets flagged for potential fraud. | |
BusinessProfileMcc | String | False |
The merchant category code for the account. | |
BusinessProfileMonthlyEstimatedRevenueAmount | Integer | False |
A non-negative integer representing how much to charge in the smallest currency unit. | |
BusinessProfileMonthlyEstimatedRevenueCurrency | String | False |
Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
BusinessProfileName | String | False |
The publicly visible name of the business. | |
BusinessProfileUrl | String | False |
The publicly visible website of the business. | |
TosAcceptanceDate | Datetime | False |
The Unix timestamp marking when the account representative accepted their service agreement. | |
TosAcceptanceIp | String | False |
The IP address from which the account representative accepted their service agreement. | |
TosAcceptanceServiceAgreement | String | False |
The user's service agreement type. | |
TosAcceptanceUserAgent | String | False |
The user agent of the browser from which the account representative accepted their service agreement. | |
TransferSchedule | String | True |
When payments collected are automatically paid out to the bank account of the account holder. | |
Type | String | False |
A type value is required when creating accounts. The standard type replaces managed: false, and the custom type replaces managed: true. The allowed values are standard, express, custom. | |
RequirementsAggregate | String | True |
The state of the information requests for the account, including what information is needed and by when it must be provided. | |
TransfersEnabled | Boolean | True |
Whether or not Stripe will send automatic transfers for this account. | |
MetadataAggregate | String | False |
The account metadata object. | |
Capabilities | String | True |
In the Accounts API, the requested_capabilities property is now required at creation time for Custom accounts in all countries. See Account capabilities for more information. | |
CompanyAddressCity | String | False |
City, district, suburb, town, or village. | |
CompanyAddressCountry | String | False |
Two-letter country code. | |
CompanyAddressLine1 | String | False |
Address line 1 (e.g., street, PO Box, or company name). | |
CompanyAddressLine2 | String | False |
Address line 2 (e.g., apartment, suite, unit, or building). | |
CompanyAddressPostalCode | String | False |
ZIP or postal code. | |
CompanyAddressState | String | False |
State, county, province, or region. | |
CompanyDirectorsProvided | Boolean | False |
Whether the company's directors have been provided. | |
CompanyExecutivesProvided | Boolean | False |
Whether the company's executives have been provided. | |
CompanyExportLicenseId | String | False |
The export license ID number of the company, also referred as Import Export Code (India only). | |
CompanyExportPurposeCode | String | False |
The purpose code to use for export transactions (India only). | |
CompanyName | String | False |
The company's legal name. | |
CompanyOwnersProvided | Boolean | False |
Whether the company's owners have been provided. | |
CompanyOwnershipDeclarationDate | Datetime | False |
The Unix timestamp marking when the beneficial owner attestation was made. | |
CompanyOwnershipDeclarationIp | String | False |
The IP address from which the beneficial owner attestation was made. | |
CompanyOwnershipDeclarationUserAgent | String | False |
The user agent string from the browser where the beneficial owner attestation was made. | |
CompanyPhone | String | False |
The company's phone number | |
CompanyRegistrationNumber | String | False |
The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. | |
CompanyStructure | String | False |
The category identifying the legal structure of the company or legal entity. | |
CompanyTaxId | String | False |
The business ID number of the company, as appropriate for the company’s country. | |
CompanyVatId | String | False |
The VAT number of the company. | |
CompanyTaxIdProvided | Boolean | True |
Whether the company's business ID number was provided. | |
CompanyTaxIdRegistrar | String | False |
The jurisdiction in which the tax_id is registered (Germany-based companies only). | |
CompanyVatIdProvided | Boolean | True |
Whether the company's business VAT number was provided. | |
CompanyVerificationDocumentBack | String | False |
A document for the company. The back of a document returned by a file upload with a purpose value of additional_verification. | |
CompanyVerificationDocumentFront | String | False |
A document for the company. The front of a document returned by a file upload with a purpose value of additional_verification. | |
IndividualId | String | True |
Unique identifier for the individual. | |
IndividualObject | String | False |
String representing the object's type. | |
IndividualAccount | String | False |
The account the individual is associated with. | |
IndividualAddressCity | String | False |
City, district, suburb, town, or village. | |
IndividualAddressCountry | String | False |
Two-letter country code. | |
IndividualAddressLine1 | String | False |
Address line 1 (e.g., street, PO Box, or company name). | |
IndividualAddressLine2 | String | False |
Address line 2 (e.g., apartment, suite, unit, or building). | |
IndividualAddressPostalCode | String | False |
ZIP or postal code. | |
IndividualAddressState | String | False |
State, county, province, or region. | |
IndividualDOBDay | Integer | False |
The day of birth, between 1 and 31. | |
IndividualDOBMonth | Integer | False |
The month of birth, between 1 and 12. | |
IndividualDOBYear | Integer | False |
The four-digit year of birth. | |
IndividualEmail | String | False |
The individual's email address. | |
IndividualFirstName | String | False |
The individual's first name. | |
IndividualFullNameAliases | String | False |
A list of alternate names or aliases that the individual is known by. | |
IndividualGender | String | False |
The individual's gender. | |
IndividualIdNumber | String | False |
The government-issued ID number of the individual, as appropriate for the representative’s country. | |
IndividualIdNumberSecondary | String | False |
The government-issued secondary ID number of the individual, as appropriate for the representative’s country, will be used for enhanced verification checks. | |
IndividualLastName | String | False |
The individual's last name. | |
IndividualMaidenName | String | False |
The individual's maiden name. | |
IndividualMetadataAggregate | String | False |
Metadata for the individual | |
IndividualNationality | String | False |
The country where the person is a national. | |
IndividualPhone | String | False |
The individual's phone number. | |
IndividualPoliticalExposure | String | False |
Indicates if the person or any other closely related persons declares that they have held an important public job or function. | |
IndividualRegisteredAddressCity | String | False |
City, district, suburb, town, or village. | |
IndividualRegisteredAddressCountry | String | False |
Two-letter country code. | |
IndividualRegisteredAddressLine1 | String | False |
Address line 1 (e.g., street, PO Box, or company name). | |
IndividualRegisteredAddressLine2 | String | False |
Address line 2 (e.g., apartment, suite, unit, or building). | |
IndividualRegisteredAddressPostalCode | String | False |
ZIP or postal code. | |
IndividualRegisteredAddressState | String | False |
State, county, province, or region. | |
IndividualSSNLast4 | String | False |
The last four digits of the individual's Social Security Number (U.S. only). | |
IndividualVerificationAdditionalDocumentBack | String | False |
The individual's verification document information. The back of an ID returned by a file upload with a purpose value of identity_document. | |
IndividualVerificationAdditionalDocumentFront | String | False |
The individual's verification document information. The front of an ID returned by a file upload with a purpose value of identity_document. | |
IndividualVerificationDocumentBack | String | False |
The individual's verification document information. The back of an ID returned by a file upload with a purpose value of identity_document. | |
IndividualVerificationDocumentFront | String | False |
The individual's verification document information. The front of an ID returned by a file upload with a purpose value of identity_document. | |
BusinessProfileAnnualRevenueAmount | Integer | False |
A non-negative integer representing the amount in the smallest currency unit. | |
BusinessProfileAnnualRevenueCurrency | String | False |
Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
BusinessProfileAnnualRevenueFiscalYearEnd | Date | False |
The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. | |
BusinessProfileEstimatedWorkerCount | Integer | False |
An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
AccountId | String |
The Id of the connected account |
CapabilitiesTransfers | Boolean |
In the Accounts API, the requested_capabilities property is now required at creation time for Custom accounts in all countries. See Account capabilities for more information.This is only for insert |
CapabilitiesCardPayments | Boolean |
In the Accounts API, the requested_capabilities property is now required at creation time for Custom accounts in all countries. See Account capabilities for more information. This is only for insert |