Establishing a Connection

Adding a Connection to Stripe

To add a connection to Stripe:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
If the Stripe icon is not available, click the Add More icon to download and install the Stripe connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Stripe

Stripe supports authentication via either a live API key or via OAuth.

Note: For refining the data returned from Stripe after you connect and authenticate, you might want to set AccountId to the Connected Account Id for which you want to obtain data. To get the account Id of that account, navigate to the Stripe dashboard and find the menu entry for connected accounts. Click that list. Stripe displays a dropdown list of all currently connected accounts.

Live API Key

Connecting via live API key requires you to set the two following configuration parameters:

AuthScheme = APIKey.
LiveAPIKey = the value of the live API key.

To obtain the value of the live API key:

Login to the Stripe dashboard.
Navigate to Developers > API keys > Secret key > Reveal live API Key.

OAuth

Stripe supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to Stripe from three common authentication flows:

Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
Web: access to data via a shared website. Authenticated via custom OAuth only.
Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.

For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Stripe, see Connection.

When the access token expires, the Sync App refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the Sync App automatically refresh the OAuth access token, do the following:

The first time you connect to data, set the following connection parameters:
- InitiateOAuth = REFRESH.
- OAuthClientId = the client Id in your application settings.
- OAuthClientSecret = the client secret in your application settings.
- OAuthAccessToken = the access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation = the path where you want the Sync App to save the OAuth values, which persist across connections.
On subsequent data connections, set the following:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
Set the following connection properties:
- OAuthClientId = the Client Id in your application settings.
- OAuthClientSecret = the Client Secret in your application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Advanced Features

This section details a selection of advanced features of the Stripe Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Stripe and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

The CData Sync App models the Stripe API as relational tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files.

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

The Sync App models the data in Tables so that it can be easily queried and updated.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Stored Procedures

Stored Procedures surface other aspects of the Stripe API.

Tables

The Sync App models the data in Stripe as a list of tables in a relational database that can be queried using standard SQL statements.

Stripe Connector for CData Sync Tables


Name	Description
Accounts	Create, update, delete, and query the Accounts you manage in Stripe.
BankAccounts	Create, update, delete, and query the available Bank Accounts in Stripe.
BankAccountTokens	Create and query the available Bank Account Tokens in Stripe.
Cards	Create, update, delete and query the available Cards in Stripe.
CardTokens	Create and query the available Card Tokens in Stripe.
Charges	Create, update, and query the available Charges in Stripe.
CheckoutSession	Creates and queries the customer's session as they pay for one-time purchases or subscriptions through Checkout or Payment Links.
Coupons	Get and delete the available discount of a Subscription.
CreditNotes	Creates, updates, and queries a credit note to adjust an invoice's amount after the invoice is finalized.
Customers	Create, update, delete, and query the available Customers in Stripe.
Disputes	Query the available Disputes in Stripe.
InvoiceItems	Create, update, delete, and query the available invoice items in Stripe.
Invoices	Create, update, delete, and query the available Invoices in Stripe.
PaymentIntent	A PaymentIntent guides you through the process of collecting a payment from your customer.
PaymentLinks	Create, update, and query the PaymentLinks in Stripe.
PaymentMethodConfigurations	Create, update, and query Payment Method Configurations in Stripe.
PaymentMethods	Create, update and query the available PaymentMethods in Stripe.
Payouts	Query the available Payouts in Stripe.
Persons	Usage information for the operation Persons.rsd.
Plans	Create, update, delete, and query the available Plans in Stripe.
Prices	Create, update, and query the available prices in Stripe.
Products	Query the available products in Stripe.
PromotionCodes	Creates, updates, and retrieves a promotion code that represents a customer-redeemable code for a coupon.
Quotes	Creates, updates, and queries the quotes available.
Refunds	Create and query the available refunds in Stripe.
ShippingRates	Query the available Shipping rates in Stripe.
SubscriptionItems	Create, update, delete, and query the available subscription items in Stripe.
Subscriptions	Create, update, delete, and query the available Subscriptions in Stripe.
TaxIds	Creates, deletes and queries the Tax Ids in Stripe.
TaxRates	Creates, updates, and queries the tax rates that applies to Invoices, Subscriptions, and Checkout Sessions to collect tax.
TestClocks	Create, delete, and query the available TestClocks in Stripe.
TopUps	Creates, updates, and queries the top-up of the Stripe balance.
TransferReversals	Create, update, and query the available reversals belonging to a specific transfer.
Transfers	Create, update, and query the available transfers in Stripe.
UsageRecords	Creates and retrieves the customer usage and metrics to Stripe for metered billing for subscription prices.
ValueListItems	Creates, deletes, and queries the Values list items.
ValueLists	Creates, updates, deletes, and queries values in a list.

Accounts

Create, update, delete, and query the Accounts you manage in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

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.
Email	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

BankAccounts

Create, update, delete, and query the available Bank Accounts in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id, CustomerId and AccountId support the following operator: =

To query the BankAccounts table, CustomerId is required:

SELECT * FROM BankAccounts WHERE CustomerId = 'cus_12345678'

Insert

To create a new bank account, specify Country, Currency, and AccountNumber. CustomerId and Object are required:

INSERT INTO BankAccounts (AccountNumber, Country, Currency, Object, AccountHolderName, AccountHolderType, MetadataAggregate, CustomerId, RoutingNumber) VALUES (000999999991,'US','usd','bank_account','Test1','company','[{\"Check\":\"123\",\"QWERTY\":\"456\"}]','cus_PEDFTqrddhgBaF',110000000)

Update

To update a bank account, specify an Id and a CustomerId:

UPDATE BankAccounts SET AccountHolderName = 'My Name', AccountHolderType = 'individual' WHERE Id = 'ba_12345678' AND CustomerId = 'cus_12345678'

Delete

To delete a bank account, specify an Id and a CustomerId:

DELETE FROM BankAccounts WHERE Id = 'ba_12345678' AND CustomerId = 'cus_12345678

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id for the bank account.
CustomerId [KEY]	String	False		The customer id this account belongs to.
Account	String	True		The account id.
AccountHolderName	String	False		The name of the person or business that owns the bank account.
AccountHolderType	String	False		The type of entity that holds the account.
AccountNumber	String	False		The type of entity that holds the account.
BankName	String	True		Name of the bank associated with the routing number.
Country	String	False		Two-letter ISO code representing the country the bank account is located in.
Currency	String	False		Three-letter ISO currency code representing the currency paid out to the bank account.
DefaultForCurrency	Boolean	True		This indicates whether or not this bank account is the default external account for its currency.
Fingerprint	String	True		Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Last4	String	True		Last 4 digits of the bank account.
RoutingNumber	String	False		The routing transit number for the bank account.
Status	String	True		The status of the account.
AccountType	String	True		The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.
MetadataAggregate	String	False		A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
Object	String	False		String representing the object's type. Objects of the same type share the same value. The allowed values are bank_account.
AvailablePayoutMethods	String	True		A set of available payout methods for this bank account. Only values from this set should be passed as the method when creating a payout.

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
Source	String	The token ID
AccountId	String	The Id of the connected account to get back accounts for

BankAccountTokens

Create and query the available Bank Account Tokens in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id and AccountId supports the following operator: =.

To query the BankAccountTokens table, the Id of desired token is required:

SELECT * FROM BankAccountTokens WHERE Id = 'btok_12345678'

Insert

To insert into BankAccountTokens, Country, and AccountNumber are required:

INSERT INTO BankAccountTokens (Country, Currency, AccountHolderName, AccountHolderType, AccountNumber, RoutingNumber)  VALUES ('US', 'USD', 'Sab nu', 'individual', '000123456789', '110000000')

Update

Update is not supported.

Delete

Delete is not supported.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the token.
BankAccountId	String	True		The bank account this token will represent.
AccountHolderName	String	False		The name of the person or business that owns the bank account.
AccountHolderType	String	False		The type of entity that holds the account.
AccountType	String	False		The type of entity that holds the account type.
AccountNumber	String	False		The type of entity that holds the account number.
BankName	String	True		Name of the bank associated with the routing number.
Fingerprint	String	True		Uniquely identifier.
Last4	String	True		The last 4 digits of the bank account number.
RoutingNumber	String	False		The routing transit number for the bank account.
Status	String	True		Status of the account.
Country	String	False		Two-letter ISO code representing the country the bank account/card is located in.
Currency	String	False		The currency of the card.
ClientIp	String	True		The IP address of the client that generated the token.
Created	Datetime	True		The datetime of the token.
Used	Boolean	True		Whether or not this token has already been used.
LiveMode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Type	String	True		Type of token.

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
CustomerId	String	The Id of the customer to create a token for.
AccountId	String	The Id of the connected account to get bank account tokens for

Cards

Create, update, delete and query the available Cards in Stripe.

Table Specific Information

This table is deprecated. Use the PaymentMethods table instead.

Select

Server-Side Query Support

The Sync App uses the Stripe API to filter the results by Id, CustomerId and AccountId. They support the equals (=) operator.

The rest of the filter is executed client-side within the Sync App.

To query the Cards table, you must specify a CustomerId:

SELECT * FROM Cards WHERE CustomerId = 'cus_12345678'

Insert

You can insert a Card Token and then insert the Token Id to Cards:

INSERT INTO CardTokens (ExpMonth, ExpYear, Number) VALUES (11, 2018, 4242424242424242 )
INSERT INTO Cards (CustomerId, Token) VALUES ('cus_123456778', 'tok_1234345565' )
INSERT INTO Cards (CustomerId,ExpMonth,ExpYear,Number,Object,Country) VALUES ('cus_PARXAI77xUsWw1',6,'2025','4242424242424242','card','russia')

Update

To update a card, specify both the Id and CustomerId:

UPDATE Cards SET ExpMonth = '06', ExpYear = '2018', AddressCity = 'Houghton Street London' WHERE Id = 'ca_12345678' AND CustomerId = 'cus_123456778'

Delete

To delete a card, specify both the Id and CustomerId:

DELETE FROM Cards WHERE Id = 'ca_12345678' AND CustomerId = 'cus_123456778'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The card Id.
CustomerId [KEY]	String	False		The customer Id this card belongs to.
ExpMonth	Integer	False		The card expiry month.
ExpYear	Integer	False		The card expiry year.
Currency	String	False		Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.
Account	String	True		The account Id this card belongs to.
Token	String	False		The token Id.
AddressCity	String	False		The city address.
AddressCountry	String	False		Billing address country, if provided when creating card.
AddressLine1	String	False		The address line 1.
AddressLine1Check	String	True		If AddressLine1 was provided. Possible values: pass, fail, unavailable, or unchecked.
AddressLine2	String	False		The address line 2.
AddressState	String	False		The address state.
AddressZip	String	False		The address ZIP.
AddressZipCheck	String	True		If AddressZip was provided. Possible values: pass, fail, unavailable, or unchecked.
Brand	String	True		Card brand.
Country	String	True		Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you have collected.
CvcCheck	String	True		If a CVC was provided. Possible values: pass, fail, unavailable, or unchecked.
Cvc	String	False		Card security code. Highly recommended to always include this value, but it’s required only for accounts based in European countries.
DefaultForCurrency	Boolean	False		Only applicable on accounts (not customers or recipients). This indicates whether or not this card is the default external account for its currency.
Number	String	False		The card number.
Fingerprint	String	True		Uniquely identifies this particular card number.
Funding	String	True		Card funding type.
Last4	String	True		Last 4 digits of the card.
Name	String	False		Cardholder name.
TokenizationMethod	String	True		If the card number is tokenized, this is the method that was used.
Metadata	String	False		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.
Object	String	False		String representing the object's type. Objects of the same type share the same value.
AvailablePayoutMethods	String	True		A set of available payout methods for this card. Only values from this set should be passed as the method when creating a payout.
DynamicLast4	String	True		(For tokenized numbers only.) The last four digits of the device account number.
WalletApplePay	String	True		If this is a apple_pay card wallet, this hash contains details about the wallet.
WalletType	String	True		The type of the card wallet, one of apple_pay. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.

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 to get cards for.

CardTokens

Create and query the available Card Tokens in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.

To query the CardTokens table, the Id of desired token is required:

SELECT * FROM CardTokens WHERE Id = 'tok_12345678'

Insert

The ExpMonth, ExpYear, and Number are required to insert a new Card Token.

INSERT INTO CardTokens (ExpMonth, ExpYear, Number) VALUES (11, 2018, 4242424242424242)

INSERT INTO CardTokens (AddressCity, AddressCountry, AddressLine1, AddressLine2, AddressZip, Currency, ExpMonth, ExpYear, Name, Number, AddressState) values ('Mohali', 'INDIA', 'TestAddressLine1', 'TestAddressLine2', 123456, 'inr', '01', '2029', 'Tapan Sharma', '4242424242424242', 'Punjab')

Update

UPDATE is not supported.

Delete

Delete is not supported.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the token.
CardId	String	True		The Id of card (used in conjunction with a customer or recipient Id)
AddressCity	String	False		The city address of the card.
AddressCountry	String	False		The country address of the card.
AddressLine1	String	False		The address line 1.
AddressLine1Check	String	True		If address_line1 was provided.
AddressLine2	String	False		The address line 2.
AddressState	String	False		The address state.
AddressZip	String	False		The zip address.
AddressZipCheck	String	True		If address_zip was provided.
Brand	String	True		The card brand.
Country	String	True		Two-letter ISO code representing the country the bank account/card is located in.
Currency	String	False		The currency of the card.
CvcCheck	String	True		If a CVC was provided.
DynamicLast4	String	True		The last four digits of the device account number.
ExpMonth	Integer	False		The card expiration month.
ExpYear	Integer	False		The card expiration year.
Last4	String	True		Last4.
Fingerprint	String	True		Uniquely identifier.
Funding	String	True		Card funding type.
Name	String	False		Cardholder name.
MetadataAggregate	String	True		The card metadata object.
TokenizationMethod	String	True		If the card number is tokenized, this is the method that was used.
ClientIp	String	True		The IP address of the client that generated the token.
Created	Datetime	True		The datetime of the token.
Used	Boolean	True		Whether or not this token has already been used.
Number	String	False		The card number.
LiveMode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Type	String	True		Type of token.

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
CustomerId	String	The Id of the customer to create a token for.
AccountId	String	The Id of the connected account to get card tokens for.

Charges

Create, update, and query the available Charges in Stripe.

Table Specific Information

In this table only select, insert, and update operations are allowed.

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the = operator.
Amount supports the <, >, >=, <=, =, != operators.
Currency supports the =, != operators.
CustomerId supports the =, != operators.
BillingDetailsAddressPostalCode supports the =, != operators.
Created supports the <, >, >=, <=, =, != operators.
Disputed supports the =,!= operator.
MetadataAggregate supports the = operator.
PaymentIntent supports the = operator.
Refunded supports the =, != operators.
Status supports the =, != operators.
TransferGroup supports the = operator.
AccountId supports the = operator.

You can select:

A Charge by specifying its Id:

SELECT * FROM Charges WHERE Id = 'ch_12345678'

Charges that belong to a customer:

SELECT * FROM Charges WHERE CustomerId = 'cus_12345678'

Charges created after a specific date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Charges WHERE Created > '2016-01-03'

Insert

Amount, Currency and Customer or Source columns are required to charge a credit card:

INSERT INTO Charges (Amount, Currency, CustomerId) VALUES (2000, 'usd', 'cus_12345678')

Update

To modify a charge, provide an Id:

UPDATE Charges SET Description = 'updated charge' WHERE Id = 'ch_17rPMOATXQzBWNrliIRnfI5B'

Delete

Delete is not supported.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the charge.
Amount	Integer	False		The amount of the charge.
Currency	String	False		The currency of the charge.
CustomerId	String	False		The customer Id of the charge.
AmountRefunded	Integer	True		The amount in cents refunded.
ApplicationFee	String	True		The application fee (if any) for the charge.
ApplicationFeeAmount	Integer	False		The amount of the application fee (if any) for the charge.
BalanceTransaction	String	True		The Id of the balance transaction that describes the impact of this charge on your account balance .
BillingDetailsAddressCity	String	True		Billing information associated with the payment method at the time of the transaction.
BillingDetailsAddressCountry	String	True		Billing information associated with the payment method at the time of the transaction.
BillingDetailsAddressLine1	String	True		Billing information associated with the payment method at the time of the transaction.
BillingDetailsAddressLine2	String	True		Billing information associated with the payment method at the time of the transaction.
BillingDetailsAddressPostalCode	String	True		Billing information associated with the payment method at the time of the transaction.
BillingDetailsAddressState	String	True		Billing information associated with the payment method at the time of the transaction.
BillingDetailsEmail	String	True		Billing information associated with the payment method at the time of the transaction.
BillingDetailsName	String	True		Billing information associated with the payment method at the time of the transaction.
BillingDetailsPhone	String	True		Billing information associated with the payment method at the time of the transaction.
Captured	Boolean	False		Whether the charge was created without capturing.
CalculatedStatementDescriptor	String	True		The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined.
Created	Datetime	True		The datetime the charge was created.
Description	String	False		The description of the charge.
Disputed	Boolean	True		Whether the charge has been disputed.
DisputeId	String	True		The Id of the associated dispute.
FailureCode	String	True		The error code explaining the reason for the charge failure if available.
FailureMessage	String	True		The message to the user further explaining the reason for the charge failure if available.
FraudDetailsStripeReport	String	True		Information on fraud assessments for the charge.
FraudDetailsUserReport	String	False		Information on fraud assessments for the charge.
Invoice	String	True		The Id of the invoice this charge is for if one exists.
Livemode	Boolean	True		Whether the charge is in live mode.
MetadataAggregate	String	False		The charge metadata object.
Order	String	True		The Id of the order this charge is for if one exists.
OutcomeAggregate	String	True		Details about whether the payment was accepted, and why. See understanding declines for details.
Paid	Boolean	True		If the charge succeeded or was successfully authorized for later capture.
PaymentIntent	String	True		ID of the PaymentIntent associated with this charge, if one exists.
PaymentMethod	String	True		ID of the payment method used in this charge.
PaymentMethodDetailsAggregate	String	True		Details about the payment method at the time of the transaction.
ReceiptEmail	String	False		The email address that the receipt for this charge was sent to.
ReceiptNumber	String	True		The transaction number that appears on email receipts sent for this charge.
ReceiptURL	String	True		This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt is stylized as an Invoice receipt.
Refunded	Boolean	True		Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
RefundsAggregate	String	True		The list of refunds that have been applied to the charge.
Review	String	True		ID of the review associated with this charge if one exists.
ShippingAddressCity	String	False		Shipping information for the charge. Shipping address. City, district, suburb, town, or village.
ShippingAddressCountry	String	False		Shipping information for the charge. Shipping address. Two-letter country code (ISO 3166-1 alpha-2)
ShippingAddressLine1	String	False		Shipping information for the charge. Shipping address. Address line 1 (e.g., street, PO Box, or company name).
ShippingAddressLine2	String	False		Shipping information for the charge. Shipping address. Address line 2 (e.g., apartment, suite, unit, or building).
ShippingAddressPostalCode	String	False		Shipping information for the charge. Shipping address. ZIP or postal code.
ShippingAddressState	String	False		Shipping information for the charge. Shipping address. State, county, province, or region.
ShippingCarrier	String	False		Shipping information for the charge. The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
ShippingName	String	False		Shipping information for the charge. Recipient name.
ShippingPhone	String	False		Shipping information for the charge. Recipient phone (including extension).
ShippingTrackingNumber	String	False		Shipping information for the charge. The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
SourceId	String	False		Source Id. The source of every charge is a credit or debit card.
SourceAddressCity	String	False		Source address city.
SourceAddressCountry	String	False		Source address country.
SourceAddressLine1	String	False		Source address line1.
SourceAddressLine2	String	False		Source address line2.
SourceAddressState	String	False		Source address state.
SourceAddressZip	String	False		Source address zip.
SourceAddressZipCheck	String	False		Source address zip check.
SourceBrand	String	False		Source brand.
SourceCountry	String	False		Source country.
SourceCustomer	String	False		Source customer.
SourceCvcCheck	String	False		Source cvc check.
SourceDynamicLast4	String	False		Source dynamic last4.
SourceExpMonth	Integer	False		Source expiry month.
SourceExpYear	Integer	False		Source expiry year.
SourceFingerprint	String	False		Source fingerprint.
SourceFunding	String	False		Source funding.
SourceLast4	Integer	False		Source last4.
SourceMetadata	String	False		Source metadata.
SourceName	String	False		Source name.
SourceObject	String	False		Source object.
SourceTokenizationMethod	String	False		Source tokenization method.
SourceWallet	String	False		Source wallet.
SourceTransfer	String	True		The transfer Id that created this charge.
StatementDescriptor	String	False		The extra information about a charge.
Status	String	True		The status of the payment is either succeeded, pending, or failed.
Transfer	String	True		The Id of the transfer to the destination account.
TransferDataAmount	Integer	False		An optional dictionary including the account to automatically transfer to as part of a destination charge.
TransferDataDestination	String	False		An optional dictionary including the account to automatically transfer to as part of a destination charge.
TransferGroup	String	False		A string that identifies this transaction as part of a group.
StatementDescriptorSuffix	String	False		Provides information about the charge that customers see on their statements.
Object	String	True		String representing the object's type. Objects of the same type share the same value.
AmountCaptured	Integer	True		Amount in cents captured
Application	String	True		ID of the Connect application that created the charge.
FailureBalanceTransaction	String	True		ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
OnBehalfOf	String	False		The account (if any) the charge was made on behalf of without triggering an automatic transfer.
RadarOptionsSession	String	False		Options to configure Radar. A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.

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 to get charges for

CheckoutSession

Creates and queries the customer's session as they pay for one-time purchases or subscriptions through Checkout or Payment Links.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following columns and operators:

Id supports the following operator: =.
CustomerId supports the following operator: =.
CustomerDetailsEmail supports the following operator: =.
PaymentIntentId supports the following operator: =.
PaymentLinkId supports the following operator: =.
Status supports the following operator: =.
SubscriptionId supports the following operator: =.
AccountId supports the following operator: =.

The rest of the filter is executed client-side within the Sync App.

You can select from the CheckoutSession table with the following queries:

SELECT * FROM CheckoutSession WHERE Id = '123124'
SELECT * FROM CheckoutSession WHERE CustomerId = 'cus_N8rO0qc7j1SJJ9'
SELECT * FROM CheckoutSession WHERE CustomerDetailsEmail = '[email protected]'
SELECT * FROM CheckoutSession WHERE PaymentIntentId = 'pi_sfuniew'

Insert

To create a new CheckoutSession, at a minimum Mode and SuccessUrl are required. If mode is payment or subscription, LineItemsAggregate is also required. Recurring payments are not supported in this context.

INSERT INTO CheckoutSession (Mode, SuccessUrl,LineItemsAggregate) VALUES ('payment', 'https://example.com/success','[{\"price\":\"price_1OPuMb2eZvKYlo2CVkxTmqYN\",\"quantity\":\"23\"}]')
INSERT INTO CheckoutSession (Mode, SuccessUrl, Currency, CustomerId) VALUES ('setup', 'https://example.com/success', 'usd', 'cus_N8rO0qc7j1SJJ9')

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the Checkout session.
AfterExpirationRecoveryAllowPromotionCodes	Boolean	False		When set, provides configuration for actions to take if this Checkout Session expires. Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to false
AfterExpirationRecoveryEnabled	Boolean	False		When set, provides configuration for actions to take if this Checkout Session expires. If true, a recovery url will be generated to recover this Checkout Session if it expires before a transaction is completed. It will be attached to the Checkout Session object upon expiration.
AfterExpirationRecoveryExpiresAt	Datetime	True		When set, provides configuration for actions to take if this Checkout Session expires. The timestamp at which the recovery URL will expire.
AfterExpirationRecoveryUrl	String	True		When set, provides configuration for actions to take if this Checkout Session expires. URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session.
AllowPromotionCodes	Boolean	False		Enables user redeemable promotion codes.
AmountSubtotal	Integer	True		Total of all items before discounts or taxes are applied.
AmountTotal	Integer	True		Total of all items after discounts and taxes are applied.
AutomaticTaxEnabled	Boolean	False		Indicates whether automatic tax is enabled for the session.
AutomaticTaxStatus	String	True		The status of the most recent automated tax calculation for this session.
BillingAddressCollection	String	False		Describes whether Checkout should collect the customer's billing address. The allowed values are auto, required.
CancelUrl	String	False		If set, Checkout displays a back button and customers are directed to this URL if they decide to cancel payment and return to your website.
ClientReferenceId	String	False		A unique string to reference the Checkout Session. This can be a customer Id, a cart Id, or something similar, and you can use it to reconcile the Session with your internal systems.
ClientSecret	String	True		Client secret to be used when initializing Stripe.js embedded checkout.
ConsentPromotions	String	True		Results of consent_collection for this session. If opt_in, the customer consents to receiving promotional communications from the merchant about this Checkout Session. The allowed values are opt_in, opt_out.
ConsentTermsOfService	String	True		Results of consent_collection for this session. If accepted, the customer in this Checkout Session has agreed to the merchant’s terms of service. The allowed values are accepted.
ConsentCollection	String	True		When set, provides configuration for the Checkout Session to gather active consent from customers.
Created	Datetime	True		The time at which the object was created. Measured in seconds since the Unix epoch.
Currency	String	False		A three-letter ISO currency code.
CurrencyConversion	String	True		Currency conversion details for automatic currency conversion sessions.
CustomFields	String	False		Collects additional information from your customer using custom fields. Up to two fields are supported.
CustomTextAfterSubmitMessage	String	False		Custom text that should be displayed after the payment confirmation button.
CustomTextShippingAddressMessage	String	False		Custom text that should be displayed alongside shipping address collection.
CustomTextSubmitMessage	String	False		Custom text that should be displayed alongside the payment confirmation button.
CustomTextTermsOfAcceptanceMessage	String	False		Custom text that should be displayed in place of the default terms of service agreement text.
CustomerId	String	False		The Id of the customer for this Session.
CustomerCreation	String	False		Configures whether a Checkout Session creates a Customer when the Checkout Session completes. The allowed values are always, if_required.
CustomerDetailsAddress	String	True		The customer's address after a completed Checkout Session.
CustomerDetailsEmail	String	True		The email associated with the Customer.
CustomerDetailsName	String	True		The customer's name after a completed Checkout Session.
CustomerDetailsPhone	String	True		The customer's phone number after a completed Checkout Session.
CustomerDetailsTaxExempt	String	True		The customer's tax exempt status after a completed Checkout Session.
CustomerDetailsTaxIds	String	True		The customer's tax Ids after a completed Checkout Session.
CustomerEmail	String	False		The email of the customer.
ExpiresAt	Datetime	False		The timestamp at which the Checkout Session expires.
InvoiceId	String	True		The Id of the invoice created by the Checkout Session.
InvoiceCreation	String	True		Details on the state of invoice creation for the Checkout Session.
Livemode	Boolean	True		true if the object is in live mode andfalse if in test mode.
Locale	String	False		The IETF language tag of the locale Checkout is displayed in.
Metadata	String	False		The set of key/value pairs that you can attach to a value list object.
Mode	String	False		The mode of the Checkout Session.
Object	String	True		String representing the object's type. Objects of the same type share the same value.
PaymentIntentId	String	True		The Id of the PaymentIntent for Checkout Sessions in payment mode.
PaymentLinkId	String	True		The Id of the Payment Link that created this Session.
PaymentMethodCollection	String	False		Configures whether a Checkout Session should collect a payment method.
PaymentMethodTypes	String	False		A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.
PaymentMethodOptions	String	False		Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
PaymentStatus	String	True		The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. The allowed values are no_payment_required, paid, unpaid.
PhoneNumberCollectionEnabled	Boolean	False		Indicates whether phone number collection is enabled for the session.
RecoveredFrom	String	True		The Id of the original expired Checkout Session that triggered the recovery flow.
Redaction	String	True		Redactions for the session.
SetupIntent	String	False		The Id of the SetupIntent for Checkout Sessions in setup mode.
ShippingAddressCollectionAllowedCountries	String	False		When set, provides configuration for Checkout to collect a shipping address from a customer.
ShippingCost	String	True		The details of the customer cost of shipping, including the customer-chosen ShippingRate.
ShippingDetails	String	True		Shipping information for this Checkout Session.
ShippingOptions	String	True		The shipping rate options applied to this Session.
Status	String	True		The status of the Checkout Session, one of open, complete, or expired.
SubmitType	String	False		Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. submit_type can only be specified on Checkout Sessions in payment mode, but not Checkout Sessions in subscription or setup mode.
SubscriptionId	String	True		The Id of the subscription for Checkout Sessions in subscription mode.
SuccessUrl	String	False		The URL the customer is directed to after the payment or subscription creation is successful.
TotalDetails	String	True		Tax and discount details for the computed total amount.
UiMode	String	False		The UI mode of the Session. Can be hosted (default) or embedded. The allowed values are hosted, embedded.
Url	String	True		The URL to the Checkout Session.
ReturnUrl	String	False		The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site. This parameter is required if ui_mode is embedded and redirect-based payment methods are enabled on the session.
LineItemsAggregate	String	False		The line items purchased by the customer.
AutomaticTaxLiabilityAccount	String	False		The connected account being referenced when type is account.
AutomaticTaxLiabilityType	String	False		Type of the account referenced. The allowed values are account, self.
RedirectOnCompletion	String	False		This parameter applies to ui_mode: embedded. Learn more about the redirect behavior of embedded sessions. Defaults to always. The allowed values are always, if_required, never.

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 to get checkout session for.

Coupons

Get and delete the available discount of a Subscription.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id support the following operator =.
CreatedAt support the following operators <,>>=,<=,=.
AccountId support the following operator =.

You can select:

A specific coupon by specifying its Id:

SELECT * FROM Coupons WHERE Id = 'nReumrk6'

Insert

To create a new coupon, at least Duration is required. If Duration is set to 'repeating', DurationInMonths is also required:

INSERT INTO Coupons (Id, Duration, DurationInMonths, PercentOff, Currency) VALUES ('12345678', 'repeating', '12', '50', 'ALL')

Update

To modify a credit note, specify its Id:

Update Coupons set name = 'non-repeating' where Id = 'mIKfjEfL'

Delete

To delete a coupon, specify the Id field:

DELETE FROM Coupons WHERE Id = 'nReumrk6'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the coupon.
CreatedAt	Datetime	True		The creation date.
Currency	String	False		If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
Duration	String	False		Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating.
DurationInMonths	Integer	False		If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
AmountOff	Integer	False		Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer.
PercentOff	Decimal	False		Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with a percent_off of 50 will make a $100 invoice $50 instead.
Valid	Boolean	True		Taking account of the above properties, whether this coupon can still be applied to a customer.
MaxRedemptions	Integer	False		Maximum number of times this coupon can be redeemed, in total, before it is no longer valid.
RedeemBy	Datetime	False		Date after which the coupon can no longer be redeemed.
MetadataAggregate	String	False		The set of key/value pairs that you can attach to a coupon object.
TimesRedeemed	Integer	True		Number of times this coupon has been applied to a customer.
Object	String	True		String representing the object's type. Objects of the same type share the same value.
AppliesTo	String	False		Contains information about what this coupon applies to. This field is not included by default. To include it in the response, expand the applies_to field.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Name	String	False		Name of the coupon displayed to customers on, for instance, invoices or receipts.

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
CurrencyOptions	String	Coupons defined in each available currency option (only supported if amount_off is passed). Each key must be a three-letter ISO currency code and a supported currency.
AccountId	String	The Id of the connected account to get coupons for.

CreditNotes

Creates, updates, and queries a credit note to adjust an invoice's amount after the invoice is finalized.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following columns and operators:

Id supports the following operator: =.
CustomerId supports the following operator: =.
InvoiceId supports the following operator: =.
AccountId supports the following operator: =.

The rest of the filter is executed client-side within the Sync App.

You can select from the CreditNotes table with the following queries:

SELECT * FROM CreditNotes WHERE Id = 'cn_1Pkjsdb';
SELECT * FROM CreditNotes WHERE CustomerId = 'cus_N8rO0qc7j1SJJ9';
SELECT * FROM CreditNotes WHERE InvoiceId = 'in_23341xds';

Insert

To create a new credit note, InvoiceId and (Amount or Lines or ShippingCost) are required:

INSERT INTO CreditNotes (InvoiceId, Amount, Reason, OutOfBandAmount) VALUES ('in_23341xds', 1, 'duplicate', 1);
INSERT INTO CreditNotes (InvoiceId, lines) VALUES ('in_23341xds','{"type":"invoice_line_item","invoice_line_item": "il_123341xds","amount": 1}');

Update

To modify a credit note, specify the credit note Id:

UPDATE CreditNotes SET Memo = 'new_memo' WHERE id='cn_1Pkjsdb';

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the credit note.
Amount	Integer	False		The integer amount in cents representing the total amount of the credit note, including tax.
AmountShipping	Integer	True		The sum of all the shipping amounts.
Created	Datetime	True		The time at which the object was created. Measured in seconds since the Unix epoch.
Currency	String	True		A three-letter ISO currency code, in lowercase.
CustomerId	String	True		The Id of customer.
CustomerBalanceTransaction	String	True		The customer balance transaction related to this credit note.
DiscountAmounts	String	True		The aggregate amounts calculated per discount for all line items.
EffectiveAt	Datetime	False		The date when this credit note goes into effect. This is the same as created unless overwritten.
InvoiceId	String	False		The Id of invoice.
Lines	String	False		Line items that make up the credit note.
Livemode	Boolean	True		true if the object is in live mode andfalse if in test mode.
Memo	String	False		Customer-facing text that appears on the credit note PDF.
Metadata	String	False		The set of key/value pairs that you can attach to a value list object.
Number	String	True		A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
OutOfBandAmount	Integer	False		Amount that was credited outside of Stripe.
Pdf	String	True		The link to download the PDF of the credit note.
Reason	String	False		The reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory. The allowed values are duplicate, fraudulent, order_change, product_unsatisfactory.
Refund	String	False		The refund related to this credit note.
ShippingCost	String	False		The details of the cost of shipping
Status	String	True		The status of this credit note, one of issued or void.
Subtotal	Integer	True		The integer amount in cents representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
SubtotalExcludingTax	Integer	True		The integer amount in cents representing the amount of the credit note, excluding all tax and invoice level discounts.
TaxAmounts	String	True		The aggregate amounts calculated per tax rate for all line items.
Total	Integer	True		The integer amount in cents representing the total amount of the credit note, including tax and all discount.
TotalExcludingTax	Integer	True		The integer amount in cents representing the total amount of the credit note, excluding tax, but including discounts.
Type	String	True		The type of this credit note, either pre_payment or post_payment.
VoidedAt	Datetime	True		The time at which the credit note was voided.

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
CreditAmount	Integer	The integer amount in cents representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice.
RefundAmount	Integer	The integer amount in cents representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
AccountId	String	The Id of the connected account to get credit notes for.

Customers

Create, update, delete, and query the available Customers in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operators: =.
Created supports the following operators: <, <=, =, >, >=.
Email supports the following operators: =.
MetadataAggregate supports the following operators: =.
Name supports the following operators: =,!=,Contains.
Phone supports the following operators: =,!=,Contains.
TestClock supports the following operators: =.
AccountId supports the following operators: =.

You can select:

A customer by specifying their Id:

SELECT * FROM Customers WHERE Id = 'cus_AA9uRhvt0xicaf'

Customers created after a specific date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Customers WHERE Created > '2016-01-03'

Insert

To create a new customer:

INSERT INTO Customers (Email, Description) VALUES ('[email protected]', 'New account')

To apply a discount to a new customer, set the DiscountId field to the CouponId, which is discounted:

INSERT INTO Customers (Email, Description, CouponId) VALUES ('[email protected]', 'New account', 'testing')

Update

To modify a customer, specify the customer's Id:

UPDATE Customers SET Description = 'An updated account' WHERE Id = 'cus_85PEPye2wfN4u4'

Delete

To delete a customer, specify the customer's Id:

DELETE FROM Customers WHERE Id = 'cus_8AcjiGnVMz2sMr'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the customer.
AddressAggregate	String	False		The customer's address.
Balance	Integer	False		The current balance of the customer.
Created	Datetime	True		The time of creation.
Currency	String	True		The currency the customer can be charged in for recurring billing purposes.
DefaultSource	String	False		The Id of the default source attached to this customer.
Delinquent	Boolean	True		Whether or not the latest charge for the latest invoice of the customer has failed.
CouponId	String	False		The Id of the discount coupon.
Description	String	False		The customer description.The description field on customer endpoints has a maximum character length limit of 350.
Email	String	False		The email of the customer.
Livemode	Boolean	True		Whether the customer is in live mode.
MetadataAggregate	String	False		The set of key/value pairs that you can attach to a customer object.
Name	String	False		The customer's full name or business name.
Phone	String	False		The customer's phone number.
ShippingAggregate	String	True		The shipping information associated with the customer.
TaxExempt	String	False		Describes the customer's tax exemption status. One of none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the text 'Reverse charge'.
InvoicePrefix	String	False		The prefix for the customer used to generate unique invoice numbers.
NextInvoiceSequence	Integer	False		The suffix of the customer's next invoice number, e.g., 0001.
TestClock	String	False		ID of the test clock this customer belongs to.
PreferredLocales	String	False		The customer's preferred locales (languages), ordered by preference.
InvoiceSettingsCustomFieldsAggregate	String	False		Default custom fields to be displayed on invoices for this customer.
InvoiceSettingsDefaultPaymentMethod	String	False		ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
InvoiceSettingsFooter	String	False		Default footer to be displayed on invoices for this customer.
TaxIdsAggregate	String	False		The customer's tax IDs.
DiscountId	String	True		The Id of the discount.
DiscountCheckoutSession	String	True		The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.
DiscountCustomer	String	True		The ID of the customer associated with this discount.
DiscountStart	Datetime	True		If the subscription has a trial, the beginning of that trial.
DiscountEnd	Datetime	True		If the subscription has a trial, the end of that trial.
DiscountInvoice	String	True		The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
DiscountInvoiceItem	String	True		The invoice line item id that the discount's coupon was applied to if it was applied directly to a invoice line item.
DiscountPromotionCode	String	True		The promotion code applied to create this discount.The promotion code applied to create this discount.
DiscountSubscription	String	True		The subscription that this coupon is applied to, if it is applied to a particular subscription.
DiscountCouponCreatedAt	Datetime	True		The creation date.
DiscountCouponCurrency	String	True		If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
DiscountCouponName	String	True		Name of the coupon displayed to customers on, for instance, invoices or receipts.
DiscountCouponDuration	String	True		One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
DiscountCouponDurationInMonths	Integer	True		the number of months the coupon applies.
DiscountCouponAmountOff	Integer	True		Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer.
DiscountCouponPercentOff	Integer	True		Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with a percent_off of 50 will make a $100 invoice $50 instead.
DiscountCouponValid	Boolean	True		Taking account of the above properties, whether this coupon can still be applied to a customer.
DiscountCouponMaxRedemptions	Integer	True		Maximum number of times this coupon can be redeemed, in total, before it is no longer valid.
DiscountCouponRedeemBy	Datetime	True		Date after which the coupon can no longer be redeemed.
DiscountCouponTimesRedeemed	Integer	True		Number of times this coupon has been applied to a customer.
DiscountCouponObject	String	True		String representing the object's type. Objects of the same type share the same value.
DiscountCouponLiveMode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
DiscountCouponMetadataAggregate	String	True		Set of key-value pairs that you can attach to an object.
SourcesAggregate	String	True		The customer?s payment sources.
SubscriptionsAggregate	String	True		The customer’s current subscriptions, if any.
TaxAutomaticTax	String	True		Surfaces if automatic tax computation is possible given the current customer location information. The allowed values are supported, not_collecting, unrecognized_location, failed.
TaxIPAddress	String	False		A recent IP address of the customer used for tax reporting and tax location inference.
TaxCountry	String	True		The customer's country as identified by Stripe Tax.
TaxState	String	True		The customer's state, county, province, or region as identified by Stripe Tax.
TaxSource	String	True		The data source used to infer the customer?s location
InvoiceSettingsRenderingOptionsAmountTaxDisplay	String	False		How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. The allowed values are exclude_tax, include_inclusive_tax.
InvoiceSettingsRenderingOptionsTemplate	String	False		ID of the invoice rendering template to be used for this customer’s invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.

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 to get customers for.
TaxValidateLocation	String	A flag that indicates when Stripe should validate the customer tax location. Defaults to deferred. Use only for INSERT and UPDATE. The allowed values are deferred, immediately.

Disputes

Query the available Disputes in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id support the following operators: =.
Created support the following operators: <,>>=,<,<=,=.
AccountId support the following operators: =.
PAymentIntent support the following operators: =.
Charge support the following operators: =.

You can select:

A dispute by specifying its Id:

SELECT * FROM Disputes WHERE Id = 'dp_12345678'

Disputes opened after a specific date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Disputes WHERE Created > '2016-01-03'

Insert

INSERT is not supported.

Update

To modify a dispute, specify the dispute Id:

UPDATE Disputes SET EvidenceCustomerName = 'Test User' WHERE Id = 'dp_12345678'

Delete

Delete is not supported.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the dispute.
Currency	String	True		Three-letter ISO currency code representing the currency of the amount that was disputed.
EvidenceAccessActivityLog	String	False		Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product.
EvidenceBillingAddress	String	False		The billing address provided by the customer.
EvidenceCancellationPolicy	String	False		Your subscription cancellation policy, as shown to the customer.
EvidenceCancellationPolicyDisclosure	String	False		An explanation of how and when the customer was shown your refund policy prior to purchase.
EvidenceCancellationRebuttal	String	False		A justification for why the customer's subscription was not canceled.
EvidenceCustomerCommunication	String	False		The (ID of a file upload) Any communication with the customer that you feel is relevant to your case (for example emails proving that they received the product or service, or demonstrating their use of or satisfaction with the product or service).
EvidenceCustomerEmailAddress	String	False		The email address of the customer.
EvidenceCustomerName	String	False		The name of the customer.
EvidenceCustomerPurchaseIp	String	False		The IP address that the customer used when making the purchase.
EvidenceCustomerSignature	String	False		The (ID of a file upload) A relevant document or contract showing the customer's signature.
EvidenceDuplicateChargeDocumentation	String	False		The (ID of a file upload) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc.
EvidenceDuplicateChargeExplanation	String	False		The explanation of the difference between the disputed charge and the prior charge that appears to be a duplicate.
EvidenceDuplicateChargeId	String	False		The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.
EvidenceProductDescription	String	False		The description of the product or service which was sold.
EvidenceReceipt	String	False		The (ID of a file upload) Any receipt or message sent to the customer notifying them of the charge.
EvidenceRefundPolicy	String	False		The (ID of a file upload) Your refund policy, as shown to the customer.
EvidenceRefundPolicyDisclosure	String	False		The documentation demonstrating that the customer was shown your refund policy prior to purchase.
EvidenceRefundRefusalExplanation	String	False		The justification for why the customer is not entitled to a refund.
EvidenceServiceDate	String	False		The date on which the customer received or began receiving the purchased service, in a clear human-readable format.
EvidenceServiceDocumentation	String	False		The (ID of a file upload) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.
EvidenceShippingAddress	String	False		The address to which a physical product was shipped. You should try to include as much complete address information as possible.
EvidenceShippingCarrier	String	False		The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.
EvidenceShippingDate	String	False		The date on which a physical product began its route to the shipping address, in a clear human-readable format.
EvidenceShippingDocumentation	String	False		The (ID of a file upload) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc, and should show the full shipping address of the customer, if possible.
EvidenceShippingTrackingNumber	String	False		The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
EvidenceUncategorizedFile	String	False		The (ID of a file upload) Any additional evidence or statements.
EvidenceUncategorizedText	String	False		Any additional evidence or statements.
EvidenceDetailsDueBy	Datetime	True		Date by which evidence must be submitted in order to successfully challenge dispute.
EvidenceDetailsHasEvidence	Boolean	True		Whether or not evidence has been saved for this dispute.
EvidenceDetailsPastDue	Boolean	True		Whether or not the last evidence submission was submitted past.
EvidenceDetailsSubmissionCount	Integer	True		The number of times the evidence has been submitted.
Amount	Integer	True		The disputed amount.
BalanceTransactionsAggregate	String	True		List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
Charge	String	True		The Id of the charge that was disputed.
Created	Datetime	True		The Date dispute was opened.
IsChargeRefundable	Boolean	True		If true, it is still possible to refund the disputed payment.
Livemode	Boolean	True		Tells if the dispute is in livemode.
Reason	String	True		The reason given by cardholder for dispute.
Status	String	True		The current status of dispute.
MetadataAggregate	String	False		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.
Transaction	String	True		The transaction being disputed.
Object	String	True		String representing the object's type. Objects of the same type share the same value.
PaymentIntent	String	True		ID of the PaymentIntent that was disputed.
PaymentMethodDetails	String	True		Additional dispute information specific to the payment method type.

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 to get disputes for.
Submit	Boolean	Whether to immediately submit evidence to the bank. If false, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to true

InvoiceItems

Create, update, delete, and query the available invoice items in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id, InvoiceId, Customer, and AccountId support the following operator: =.
Date supports the following operators: <, >, >=, <, <=, =.

You can select:

An InvoiceItem by specifying its Id:

SELECT * FROM InvoiceItems WHERE Id = 'or_12345678'

InvoiceItems for a given Customer:

SELECT * FROM InvoiceItems WHERE Customer = 'cus_12345678'

InvoiceItems created after a specific date (Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM InvoiceItems WHERE Date = '2018-11-16 10:59:00.0'

Insert

To create a new InvoiceItem, the Customer, Currency, and Amount fields are required:

INSERT INTO InvoiceItems (Customer, Currency, Amount) VALUES ('cus_NBs3z63zmfCJy1', 'USD', '225')

INSERT can be executed by specifying the DiscountsAggregate column. The columns that are not read-only can be inserted (optional). DiscountsAggregate is an aggregate column.

To insert using this column as Temp table:

INSERT INTO InvoiceItemDiscounts#TEMP (Coupon) VALUES ('Pqx2fHKt');

INSERT INTO InvoiceItems (Customer, Amount, Currency, DiscountsAggregate) VALUES ('cus_O20ZOZfrjjJeGj', 25000, 'USD', 'InvoiceItemDiscounts#TEMP');

To insert using this column as JSON:

INSERT INTO InvoiceItems (Customer, currency, MetadataAggregate, PeriodEnd, PeriodStart, DiscountsAggregate, PriceDataProduct, PriceDataCurrency) Values ('cus_PARXAI77xUsWw1', 'USD' ,'[{\"key\":\"test2\",\"type\":\"text\",\"test\":\"value\"}]', '2023-11-03 14:00:09.000000', '2023-11-03 14:00:08.000000','[{\"discount\":\"text\"},{\"discount\":\"value\"}]', 'product1', 'usd')

INSERT can be executed by specifying the TaxRatesAggregate column. The columns that are not read-only can be inserted (optional):

INSERT INTO InvoiceItems (Customer, Currency, Amount, TaxRatesAggregate) VALUES ('cus_9s6XKzkNRiz8i3', 'USD', 125614, '[\"txr_1OL7oy2eZvKYlo2CLylDtkiI\",\"txr_1OL7oo2eZvKYlo2CHliiOEZT\"]');

Update

To update an InvoiceItem, specify an Id:

UPDATE InvoiceItems SET PeriodStart = '2023-11-03 14:00:06.000000', PeriodEnd = '2023-11-03 14:00:08.000000' WHERE Id = 'ii_1OIS6s2eZvKYlo2COIxLnMms'

Delete

To delete an InvoiceItem, specify an Id:

DELETE from InvoiceItems WHERE Id = 'ii_1OP2II2eZvKYlo2CLc0nHFnR'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the invoice item.
InvoiceId	String	False	Invoices.Id	The Id of the invoice.
Amount	Int	False		The amount, in cents.
Customer	String	False	Customers.Id	The ID of the customer who will be billed when this invoice item is billed.
Currency	String	False		Three-letter ISO currency code, in lowercase. Must be a supported currency.
Date	Datetime	False		Time at which the object was created.
Description	String	False		An arbitrary string attached to the object. Often useful for displaying to users. The description field on invoice line items has a maximum character length limit of 500.
Discountable	Boolean	False		If true, discounts will apply to this line item. This is always false for prorations.
LiveMode	Boolean	False		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
PeriodStart	Datetime	False		The start of the period.
PeriodEnd	Datetime	False		The end of the period which must be greater than or equal to the start.
PlanId	String	False		Unique identifier for the plan.
PlanAggregate	String	True		The plan of the subscription, if the line item is a subscription or a proration.
PriceId	String	False		Unique identifier for the price.
PriceAggregate	String	True		The price of the invoice item.
Proration	Boolean	True		Whether this is a proration.
Quantity	Int	False		The quantity of the subscription, if the line item is a subscription or a proration.
Subscription	String	False		The Id of the subscription the item pertains to.
SubscriptionItems	String	False		The subscription item that this invoice item has been created for, if any.
TestClock	String	False		ID of the test clock this invoice item belongs to.
UnitAmount	Integer	False		Unit amount (in the currency specified) of the invoice item.
UnitAmountDecimal	Decimal	False		Decimal value of Unit amount (in the currency specified) of the invoice item.
MetadataAggregate	String	False		The metadata object.
DiscountsAggregate	String	False		The discounts which apply to the invoice item.
TaxRatesAggregate	String	False		The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.

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
PriceDataProduct	String	The ID of the product that this price will belong to. This is a psuedo-column to support insert operations.
PriceDataCurrency	String	Three-letter ISO currency code, in lowercase. Must be a supported currency. This is a psuedo-column to support insert operations.
PriceDataTaxBehavior	String	Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. This is a psuedo-column to support insert operations.
PriceDataUnitAmount	Int	A positive integer in cents (or 0 for a free price) representing how much to charge. This is a psuedo-column to support insert operations.
PriceDataUnitAmountDecimal	String	Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set. This is a psuedo-column to support insert operations.
TaxBehavior	String	Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. This is a psuedo-column to support insert operations.
TaxCode	String	A tax code ID.
AccountId	String	The Id of the connected account to get invoice line items for.

Invoices

Create, update, delete, and query the available Invoices in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id, CustomerId, CollectionMethod, Upcoming, AutoAdvance, Currency, Metadata, Number, ReceiptNumber, Status, and Subscription support the following operator: =.
Created and Total support the following operators: <, >, >=, <, <=, =.

You can select:

An Invoice by specifying its Id:

SELECT * FROM Invoices WHERE Id = 'or_12345678'

An Invoice created after a specific date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Invoices WHERE Created = '2023-07-21 19:00:27.0'

Invoices for a given Customer:

SELECT * FROM Invoices WHERE CustomerId = 'cus_12345678'

Invoices by AutoAdvance:

SELECT * FROM Invoices WHERE AutoAdvance = True

Invoices by Subscription:

SELECT * FROM Invoices WHERE Subscription = 'sub_12345678'

Insert

To create a new invoice, the CustomerId, CollectionMethod, DaysUntilDue, and PendingInvoiceItemsBehavior fields are required. CustomFieldsAggregate is an aggregate column.

To insert using this column:

INSERT INTO Invoices (CustomerId, CollectionMethod, DaysUntilDue, PendingInvoiceItemsBehavior, CustomFieldsAggregate) VALUES ('cus_MDxevmmMzKidZc', 'send_invoice', 30, 'exclude', '{\"name\":\"cf_test\",\"value\":\"mycfvalue\"}')

INSERT can be executed by specifying the AccountTaxRates column. The columns that are not read-only can be inserted (optional). AccountTaxRates expects TaxRateIds as an array of strings.

INSERT INTO Invoices(CustomerID, Subscription, AccountTaxRates) VALUES ('cus_9s6XKzkNRiz8i3', 'sub_1OHM2S2eZvKYlo2C8dDGfEdN', '[\"txr_1OL7oy2eZvKYlo2CLylDtkiI\",\"txr_1OL7oo2eZvKYlo2CHliiOEZT\"]');

INSERT can be executed by specifying the Discounts column. The columns that are not read-only can be inserted (optional). Discounts is an aggregate column.

To insert using this column:

INSERT INTO InvoiceDiscounts#TEMP (Coupon) VALUES ('dsocsdc')

INSERT INTO Invoices (CustomerId, Discounts) VALUES ('cus_Oscvdvdw3fcd', 'InvoiceDiscounts#TEMP')

Update

To update an Invoice, specify an Id

UPDATE Invoices SET DefaultTaxRates = '[\"txr_1OL7oy2eZvKYlo2CLylDtkiI\",\"txr_1OL7oo2eZvKYlo2CHliiOEZT\"]' WHERE Id='in_1OMk0u2eZvKYlo2CGzA4kQ5A'

Delete

To delete an Invoice, specify the Id of the Invoice. Only draft invoices can be deleted.

DELETE FROM Invoices WHERE Id = 'in_1MOZcISC4snQ4WkOaa5LZmkj'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the invoice.
CustomerId	String	False	Customers.Id	The Id of the customer to be billed.
AccountCountry	String	True		The country of the business associated with this invoice, most often the business creating the invoice.
AccountName	String	True		The name of the business associated with this invoice, most often the business creating the invoice.
AccountTaxRates	String	False		The account tax IDs associated with the invoice.
AmountDue	Int	True		Final amount due at this time for this invoice.
AmountPaid	Int	True		The amount, in cents, that was paid.
AmountRemaining	Int	True		The amount remaining, in cents, that is due.
Application	String	True		ID of the Connect Application that created the invoice.
ApplicationFeeAmount	Int	False		The fee in cents that is applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.
AttemptCount	Int	True		Number of payment attempts made for this invoice, from the perspective of the payment retry schedule.
Attempted	Boolean	True		Whether an attempt has been made to pay the invoice.
AutomaticTaxEnabled	Boolean	False		Whether Stripe automatically computes tax on this invoice.
AutomaticTaxStatus	String	True		The status of the most recent automated tax calculation for this invoice.
BillingReason	String	True		Indicates the reason why the invoice was created.
CollectionMethod	String	False		Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. The allowed values are charge_automatically, send_invoice.
Charge	String	True		ID of the latest charge generated for this invoice, if any.
AutoAdvance	Boolean	False		Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice's state will not automatically advance without an explicit action.
Currency	String	False		Three-letter ISO currency code, in lowercase.
Created	Datetime	True		Time at which the object was created. Measured in seconds since the Unix epoch.
Description	String	False		An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
DefaultPaymentMethod	String	False		ID of the default payment method for the invoice.
DefaultSource	String	False		ID of the default payment source for the invoice.
DefaultTaxRates	String	False		The tax rates applied to this invoice.
DiscountName	String	True		Name of the coupon.
DiscountAmount	String	True		Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer.
CouponId	String	True		Id of the coupon.
Discounts	String	False		The discounts applied to the invoice.
DueDate	Datetime	False		The date on which payment for this invoice is due. This value is null for invoices where collection_method=charge_automatically.
EndingBalance	Int	True		Ending customer balance after the invoice is finalized.
InvoicePdf	String	True		The link to download the PDF for the invoice. If the invoice has not been finalized yet, this is null.
Footer	String	False		Footer displayed on the invoice.
LastFinalizationError	String	True		The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
HostedInvoiceUrl	String	True		The URL for the hosted invoice page, which allows customers to view and pay an invoice.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
MetadataAggregate	String	False		The set of key/value pairs that you can attach to a subscription object.
CustomFieldsAggregate	String	False		Custom Fields object.
NextPaymentAttempt	Datetime	True		The time at which payment will next be attempted.
Number	String	True		A unique, identifying string that appears on emails sent to the customer for this invoice.
OnBehalfOf	String	False		The account (if any) for which the funds of the invoice payment are intended.
Paid	Boolean	True		Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.
PaidOutOfBand	Boolean	True		Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.
PaymentIntent	String	True		The PaymentIntent associated with this invoice.
PaymentMethodOptions	String	True		Payment-method-specific configuration to provide to the invoice's PaymentIntent.
PaymentMethodTypes	String	False		The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent.
PostPaymentCreditNotesAmount	Int	True		Total amount of all post-payment credit notes issued for this invoice.
PrePaymentCreditNotesAmount	Int	True		Total amount of all pre-payment credit notes issued for this invoice.
Quote	String	True		The quote Id this invoice was generated from.
PeriodEnd	Datetime	True		End of the usage period during which invoice items were added to this invoice.
PeriodStart	Datetime	True		Start of the usage period during which invoice items were added to this invoice.
ReceiptNumber	String	True		This is the transaction number that appears on email receipts sent for this invoice.
StartingBalance	Int	True		Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance.
StatementDescriptor	String	False		If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.
Status	String	True		The status of the invoice, one of draft, open, paid, uncollectible, or void. Instead of checking the forgiven field on an invoice, check for the uncollectible status. Instead of setting the forgiven field on an invoice, mark it as uncollectible. The allowed values are draft, open, paid, uncollectible, void.
Subscription	String	False		The subscription that this invoice was prepared for, if any.
StatusTransitionsFinalizedAt	Datetime	True		The time that the invoice draft was finalized.
StatusTransitionsMarkedUncollectibleAt	Datetime	True		The time that the invoice was marked uncollectible.
StatusTransitionsPaidAt	Datetime	True		The time that the invoice was paid.
StatusTransitionsVoidedAt	Datetime	True		The time that the invoice was voided.
Subtotal	Int	True		Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied.
Tax	Int	True		The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
TestClock	String	True		ID of the test clock this invoice item belongs to.
Total	Int	True		Total after discounts and taxes.
TotalDiscountAmounts	String	True		The aggregate amounts calculated per discount across all line items.
TotalTaxAmounts	String	True		The aggregate amounts calculated per tax rate for all line items.
TransferDataAmount	Int	False		The amount that will be transferred to the destination account when the invoice is paid.
TransferDataDestination	String	False		The account where funds from the payment will be transferred to upon payment success.
WebhooksDeliveredAt	Datetime	True		Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted.
AmountShipping	Int	True		This is the sum of all the shipping amounts.
ShippingDetails	String	True		Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
ShippingCost	String	False		The details of the cost of shipping, including the ShippingRate applied on the invoice.
CustomerAddress	String	True		The customer's address.
CustomerEmail	String	True		The customer's email.
CustomerName	String	True		The customer's name.
CustomerPhone	String	True		The customer's phone number.
CustomerShipping	String	True		The customer's shipping information.
CustomerTaxExempt	String	True		The customer's tax exempt status.
CustomerTaxIds	String	True		The customer's tax Ids.
EffectiveAt	Datetime	False		The date when this invoice is in effect. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
Lines	String	False		The individual line items that make up the invoice.
AutomaticTaxLiabilityAccount	String	False		The connected account being referenced when type is account.
AutomaticTaxLiabilityType	String	False		Type of the account referenced. The allowed values are account, self.
FromInvoiceAction	String	False		The relation between this invoice and the cloned invoice.
FromInvoiceInvoice	String	False		The invoice that was cloned. For insertion use the id of the invoice that will be cloned.
IssuerAccount	String	False		The connected account being referenced when IssuerType is account.
IssuerType	String	False		Type of the account referenced. The allowed values are account, self.
RenderingAmountTaxDisplay	String	False		How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. The allowed values are exclude_tax, include_inclusive_tax.
RenderingPdfPageSize	String	False		Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale. The allowed values are a4, auto, letter.
RenderingTemplate	String	False		ID of the rendering template that the invoice is formatted by.
RenderingTemplateVersion	Integer	False		Version of the rendering template that the invoice is using.
RenderingOptions	String	True		The rendering options of the invoice.
SubscriptionDetailsMetadata	String	True		Set of key-value pairs defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. Note: This attribute is populated only for invoices created on or after June 29, 2023.
PaymentSettingsDefaultMandate	String	False		ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice’s default_payment_method or default_source, if set.
SubtotalExcludingTax	Integer	True		The integer amount in cents representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated.
TotalExcludingTax	Integer	True		The integer amount in cents representing the total amount of the invoice including all discounts but excluding all tax.
LatestRevision	String	True		The ID of the most recent non-draft revision of this invoice.

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
PendingInvoiceItemsBehavior	String	For Insert this column is required The allowed values are exclude, include.
Upcoming	Boolean	Determines if the select is for upcoming invoices.
DaysUntilDue	Int	The number of days from which the invoice is created until it is due. Only valid for invoices where billing=send_invoice.
Forgive	Boolean	Determines if invoice should be forgiven if source has insufficient funds to fully pay the invoice.
Source	String	A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.
AccountId	String	The Id of the connected account to get invoices for

PaymentIntent

A PaymentIntent guides you through the process of collecting a payment from your customer.

Table Specific Information

Select

The Sync App 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 Sync App.

Id support the following operator: =.
Amount support the following operator: =.
Customer support the following operator: =.
Currency support the following operator: =.
Metadata support the following operator: =.
Status support the following operators: =, !=.
Created support the following operators: =, !=, >, >=, <, <=.

You can select from the PaymentIntent table with the following queries:

SELECT * FROM PaymentLinks WHERE Id = 'pi_3MOZgsSC4snQ4WkO1git8c00'
SELECT * FROM PaymentLinks WHERE Customer = 'cus_N8rO0qc7j1SJJ9'
SELECT * from PaymentLinks where MetadataAggregate ='{\"key\":\"value\"}'

Insert

Amount and Currency are required to create a PaymentIntent:

INSERT INTO PaymentIntent(Amount,Currency,MetadataAggregate) values (123,'usd','[{\"nsame\":\"asdsa\"}]')

Update

To update a PaymentIntent, specify Id column:

Update PaymentIntent set description ='andasdn' where id = 'pi_3OQAkKCZ8rn6qR6h1liiAZfx'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique identifier for the object.
Amount	Integer	False		Amount intended to be collected by this PaymentIntent.
AmountDetailsTip	String	True		Amount Details Tip
AmountCapturable	Integer	True		Amount that can be captured from this PaymentIntent.
AmountReceived	Integer	True		Amount that was collected by this PaymentIntent.
ApplicationFeeAmount	Integer	False		The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owners Stripe account.
AutomaticPaymentMethodsEnabled	Boolean	False		Automatically calculates compatible payment methods
AutomaticPaymentMethodsAllowRedirects	String	False		Controls whether this PaymentIntent will accept redirect-based payment methods.
CanceledAt	Datetime	True		Populated when status is canceled, this is the time at which the PaymentIntent was canceled.
CancellationReason	String	True		Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).
CaptureMethod	String	False		Controls when the funds will be captured from the customers account.
ClientSecret	String	True		The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
ConfirmationMethod	String	False		Possible enum values-automatic, manual
Created	Datetime	True		Time at which the object was created. Measured in seconds since the Unix epoch.
Currency	String	False		Three-letter ISO currency code, in lowercase.
Application	String	True		ID of the Connect application that created the PaymentIntent.
Customer	String	False		ID of the Customer this PaymentIntent belongs to, if one exists.
LatestCharge	String	True		The latest charge created by this payment intent.
PaymentMethod	String	False		ID of the payment method used in this PaymentIntent.
TransferDataDestination	String	False		The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success.
OnBehalfOf	String	False		The account (if any) for which the funds of the PaymentIntent are intended.
Invoice	String	True		ID of the invoice that created this PaymentIntent, if it exists.
Review	String	True		ID of the review associated with this PaymentIntent, if any.
Description	String	False		An arbitrary string attached to the object. Often useful for displaying to users.
LastPaymentErrorCharge	String	True		For card errors, the ID of the failed charge.
LastPaymentErrorCode	String	True		For some errors that could be handled programmatically, a short string indicating the error code reported.
LastPaymentErrorDeclineCode	String	True		For some errors that could be handled programmatically, a short string indicating the error code reported.
LastPaymentErrorDocURL	String	True		A URL to more information about the error code reported.
LastPaymentErrorMessage	String	True		A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
LastPaymentErrorParam	String	True		If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
LastPaymentErrorPaymentMethod	String	True		The PaymentMethod object for errors returned on a request involving a PaymentMethod.
LastPaymentErrorPaymentMethodType	String	True		If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
LastPaymentErrorType	String	True		The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
LiveMode	Boolean	True		Has the value true if the object exists in live mode or the value true if the object exists in test mode.
NextAction	String	True		If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
Object	String	True		String representing the objects type. Objects of the same type share the same value.
PaymentMethodOptions	String	False		Payment-method-specific configuration for this PaymentIntent.
PaymentMethodTypes	String	False		The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
PaymentMethodConfigurationDetailsId	String	False		ID of the payment method configuration used.
PaymentMethodConfigurationDetailsParent	String	False		ID of the parent payment method configuration used.
ProcessingCard	String	True		If the PaymentIntents payment_method_types includes card, this hash contains the details on the processing state of the payment.
ProcessingType	String	True		Type of the payment method for which payment is in processing state, one of card.
ReceiptEmail	String	False		Set of key-value pairs that you can attach to an object.
MetadataAggregate	String	False		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.
SetupFutureUsage	String	False		Indicates that you intend to make future payments with this PaymentIntents payment method.
ShippingAddressCity	String	False		City, district, suburb, town, or village..
ShippingAddressCountry	String	False		Two-letter country code
ShippingAddressline1	String	False		Address line 1
ShippingAddressline2	String	False		Address line 2
ShippingAddressPostalCode	String	False		ZIP or postal code.
ShippingAddressState	String	False		State, county, province, or region.
ShippingCarrier	String	False		The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
ShippingName	String	False		Recipient name.
ShippingPhone	String	False		Recipient phone (including extension).
ShippingTrackingNumber	String	False		The tracking number for a physical product, obtained from the delivery service.
StatementDescriptor	String	False		For non-card charges, you can use this value as the complete description that appears on your customers statements.
StatementDescriptorSuffix	String	False		Provides information about a card payment that customers see on their statements.
Status	String	True		Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.
TransferDataAmount	Integer	False		Amount intended to be collected by this PaymentIntent.
TransferGroup	String	False		A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

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
Confirm	Boolean	Set to true to attempt to confirm this PaymentIntent immediately. This column is supported in INSERT.
OffSession	Boolean	Set to true to indicate that the customer isn�t in your checkout flow during this payment attempt and can�t authenticate. This parameter can only be used with confirm=true. This column is supported in INSERT.
ErrorOnRequiresAction	Boolean	Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. Use this parameter for simpler integrations that don�t handle customer actions, such as saving cards without authentication. This parameter can only be used with confirm=true. This column is supported in INSERT.
Mandate	String	ID of the mandate that�s used for this payment. This parameter can only be used with confirm=true. This column is supported in INSERT.
MandateDataCustomerAcceptanceType	String	The type of customer acceptance information included with the Mandate. One of online or offline. This parameter can only be used with confirm=true. This column is supported in INSERT. The allowed values are online, offline.
MandateDataCustomerAcceptanceAcceptedAt	Datetime	The time at which the customer accepted the Mandate. This parameter can only be used with confirm=true. This column is supported in INSERT.
MandateDataCustomerAcceptanceOffline	String	If this is a Mandate accepted offline, this hash contains details about the offline acceptance. This parameter can only be used with confirm=true. This column is supported in INSERT.
MandateDataCustomerAcceptanceOnlineIPAddress	String	The IP address from which the Mandate was accepted by the customer. This parameter can only be used with confirm=true. This column is supported in INSERT.
MandateDataCustomerAcceptanceOnlineUserAgent	String	The user agent of the browser from which the Mandate was accepted by the customer. This parameter can only be used with confirm=true. This column is supported in INSERT.
RadarOptionsSession	String	A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. This column is supported in INSERT.
ReturnURL	String	The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method�s app or site. This parameter can only be used with confirm=true. This column is supported in INSERT.

PaymentLinks

Create, update, and query the PaymentLinks in Stripe.

Table Specific Information

Select

The Sync App 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 Sync App.

Id supports the following operator: =.
Active supports the following operator: =.
AccountId supports the following operator: =.

You can select from the PaymentLinks table with the following queries:

SELECT * FROM PaymentLinks WHERE Id = 'plink_1MHKmISC4snQ4WkOZ7vBfsGz'
SELECT * FROM PaymentLinks WHERE Active = 'true'
SELECT * FROM PaymentLinks WHERE AccountId = 'acct_1MGcyqSC4snQ4WkO'

Insert

INSERT can be executed by specifying the LineItems column. The columns that are not read-only can be inserted optionally. LineItems is an aggregate column. See the example below on how to insert using this column.

INSERT INTO PaymentLinkLineItems#TEMP (PriceId, Quantity) VALUES ('price_1MGhiLSC4snQ4WkOdVl8fSu2', 12)

INSERT INTO PaymentLinks (CustomFieldsAggregate,LineItems) VALUES ('{"key":"test1","type":"text"}', PaymentLinkLineItems#TEMP)

Insertion in PaymentLinks can also be done through a JSON String. See the example below:

INSERT INTO PaymentLinks (LineItems) VALUES ('{\"priceid\":\"price_1MGhiLSC4snQ4WkOdVl8fSu2\", \"quantity\":\"6\"}')

Insert can also be done by specifying MetadataAggregate with LineItems column. The columns that are not read-only can be inserted optionally.

INSERT INTO PaymentLinks(LineItems,MetadataAggregate,AfterCompletionHostedConfirmationCustomMessage,AfterCompletionType,AllowPromotionCodes)values ('[{\"price\":\"price_1OPPwR2eZvKYlo2CcNoquIuL\",\"Quantity\":\"245\"}]','[{\"order_id\":\"2415362\"}]','Hello','hosted_confirmation',true)

To add custom fields to the related invoice see the example below:

Insert into PaymentLinks(LineItems, InvoiceCreationEnabled, InvoiceCreationInvoiceDataCustomFields) Values (PaymentLinkLineItems#TEMP, true, '[{\"name\": \"b\", \"value\": 1}, {\"name\": \"c\", \"value\": 2}]')

Update

To update a PaymentLinks, specify Id column.

INSERT INTO PaymentLinkLineItems#TEMP (Id, Quantity) VALUES ('li_N41aipJlFRxvEQ', 17)

UPDATE PaymentLinks SET LineItems = 'PaymentLinkLineItems#TEMP' WHERE Id = 'plink_1MJtXUSC4snQ4WkOhs6HJqLr'

You can also perform updates in PaymentLinks through a JSON String. See the example below:

UPDATE PaymentLinks SET LineItems = '{\"quantity\":\"69\", \"id\":\"li_N40wBnIKX6599N\"}', PaymentMethodTypes='[\"card\"]' WHERE Id = 'plink_1MJsuWSC4snQ4WkOXm8qlChy'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the Payment Link.
Active	Boolean	False		Only return payment links that are active or inactive.
AfterCompletionHostedConfirmationCustomMessage	String	False		A custom message to display to the customer after the purchase is complete.
AfterCompletionType	String	False		The specified behavior after the purchase is complete.
AfterCompletionRedirectURL	String	False		The specified behavior after the purchase is complete.
AllowPromotionCodes	Boolean	False		Enables user redeemable promotion codes.
ApplicationFeeAmount	Integer	False		The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner Stripe account. Can only be applied when there are no line items with recurring prices.
ApplicationFeePercent	Decimal	False		A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner Stripe account.
AutomaticTaxEnabled	Boolean	False		If it is set to true, tax will be calculated automatically using the customer location.
BillingAddressCollection	String	False		Configuration for collecting the customers billing address.
ConsentCollectionPromotions	String	False		Configure fields to gather active consent from customers. If set to auto, enables the collection of customer consent for promotional communications. Possible values are auto and none.
ConsentCollectionTermsOfService	String	False		Configure fields to gather active consent from customers. If set to required, it requires customers to check a terms of service checkbox before being able to pay. Possible values are required and none.
ConsentCollectionPaymentMethodResuseAgreementPosition	String	False		Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe’s defaults will be used. When set to hidden, the payment method reuse agreement text will always be hidden in the UI.
Currency	String	False		Three-letter ISO currency code, in lowercase.
CustomTextShippingAddressMessage	String	False		Custom text that should be displayed alongside shipping address collection.
CustomTextSubmitMessage	String	False		Custom text that should be displayed alongside the payment confirmation button.
CustomTextAfterSubmitMessage	String	False		Custom text that should be displayed after the payment confirmation button.
CustomTextTermsOfServiceAcceptanceMessage	String	False		Custom text that should be displayed in place of the default terms of service agreement text.
CustomerCreation	String	False		Configures whether checkout sessions created by this payment link create a Customer. Possible values are if_required and always.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Object	String	True		String representing the object type.
OnBehalfOf	String	False		The account on behalf of which to charge.
MetadataAggregate	String	False		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.
PaymentIntentDataCaptureMethod	String	False		Controls when the funds will be captured from the customer account. Possible values are automatic and manual.
PaymentIntentDataSetupFutureUsage	String	False		Indicates that you intend to make future payments with the payment method collected by this Checkout Session. Possible values are on_session and off_session.
PaymentMethodCollection	String	False		Configuration for collecting a payment method during checkout. Possible values are always and if_required.
PaymentMethodTypes	String	False		The list of payment method types that customers can use. Possible values are card, affirm, promptpay, bacs_debit, bancontact, blik, boleto, eps, fpx, giropay, grabpay, ideal, klarna, konbini, oxxo, p24, paynow, pix, afterpay_clearpay, alipay, au_becs_debit, sepa_debit, sofort, us_bank_account, wechat_pay.
PhoneNumberberCollectionEnabled	Boolean	False		If true, a phone number will be collected during checkout.
ShippingAddressCollectionAllowedCountries	String	False		An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations.
ShippingOptions	String	False	ShippingRates.Id	The shipping rate options applied to the session.
SubmitType	String	False		Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
SubscriptionDataDescription	String	False		The subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.
SubscriptionDataTrialPeriodDays	Integer	False		Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
TaxIdCollectionEnabled	Boolean	False		Details on the state of tax ID collection for the payment link.
TransferDataDestination	String	False		The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
TransferDataAmount	Int	False		The amount that will be transferred automatically when a charge succeeds.
Url	String	True		The public URL that can be shared with customers.
LineItems	String	False		The line items representing what is being sold. Each line item represents an item being sold.
CustomFieldsAggregate	String	False		Custom Fields object.
AutomaticTaxLiabilityType	String	False		Type of the account referenced in the request. The allowed values are account, self.
AutomaticTaxLiabilityAccount	String	False		The connected account being referenced when type is account.
InactiveMessage	String	False		The custom message to be displayed to a customer when a payment link is no longer active.
InvoiceCreationEnabled	Boolean	False		Enable creating an invoice on successful payment for payment mode payment links.
InvoiceCreationInvoiceDataAccountTaxIds	String	False		The account tax IDs associated with the invoice. Default invoice values will be used if unspecified.
InvoiceCreationInvoiceDataCustomFields	String	False		A list of up to 4 custom fields to be displayed on the invoice.
InvoiceCreationInvoiceDataDescription	String	False		An arbitrary string attached to the object. Often useful for displaying to users.
InvoiceCreationInvoiceDataFooter	String	False		Footer to be displayed on the invoice.
InvoiceCreationInvoiceDataIssuerAccount	String	False		The connected account being referenced when invoice data issuer type is account.
InvoiceCreationInvoiceDataIssuerType	String	False		Type of the account referenced. The allowed values are account, self.
InvoiceCreationInvoiceDataMetadata	String	False		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.
InvoiceCreationInvoiceDataRenderingOptionsAmountTaxDisplay	String	False		How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts. The allowed values are exclude_tax, include_inclusive_tax.
RestrictionsCompletedSessionsCount	Integer	True		The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met.
RestrictionsCompletedSessionsLimit	Integer	False		The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.

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.

PaymentMethodConfigurations

Create, update, and query Payment Method Configurations in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id and Application support the following operator: =.

You can select:

All payment method configurations:

SELECT * FROM PaymentMethodConfigurations

A payment method configuration by specifying its Id:

SELECT * FROM PaymentMethodConfigurations WHERE Id = 'pmc_1Q3YXeATXQzBWNrl5zbq9orM'

Payment method configurations associated with an application:

SELECT * FROM PaymentMethodConfigurations WHERE Application = 'ca_81Gw6dl5WN1GwS1VOKGC3vPUwwY7HvDD'

Insert

Name column is required to create a new payment method configuration:

INSERT INTO PaymentMethodConfigurations (Name, CardDisplayPreferencePreference, ApplePayLaterDisplayPreferencePreference, PaypalDisplayPreferencePreference, GooglePayDisplayPreferencePreference) VALUES ('homelander', 'on', 'on', 'on', 'on')

Update

To update a payment method configuration, specify the Id:

UPDATE PaymentMethodConfigurations SET GooglePayDisplayPreferencePreference = 'off' WHERE Id='pmc_1Q3YXeATXQzBWNrl5zbq9orM'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the Payment Method Configuration.
Active	Boolean	False		Whether the configuration can be used for new payments.
Application	String	True		For child configs, the Connect application associated with the configuration.
IsDefault	Boolean	True		The default configuration is used whenever a payment method configuration is not specified.
Name	String	False		The configuration's name.
Parent	String	False		For child configs, the configuration's parent configuration.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Object	String	True		String representing the object's type. Objects of the same type share the same value.
AcssDebitAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
AcssDebitDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
AcssDebitDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
AcssDebitDisplayPreferenceValue	String	True		The effective display preference value.
AffirmAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
AffirmDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
AffirmDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
AffirmDisplayPreferenceValue	String	True		The effective display preference value.
AfterpayClearpayAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
AfterpayClearpayDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
AfterpayClearpayDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
AfterpayClearpayDisplayPreferenceValue	String	True		The effective display preference value.
AlipayAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
AlipayDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
AlipayDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
AlipayDisplayPreferenceValue	String	True		The effective display preference value.
AmazonPayAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
AmazonPayDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
AmazonPayDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
AmazonPayDisplayPreferenceValue	String	True		The effective display preference value.
ApplePayAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
ApplePayDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
ApplePayDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
ApplePayDisplayPreferenceValue	String	True		The effective display preference value.
AuBecsDebitAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
AuBecsDebitDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
AuBecsDebitDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
AuBecsDebitDisplayPreferenceValue	String	True		The effective display preference value.
BacsDebitAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
BacsDebitDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
BacsDebitDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
BacsDebitDisplayPreferenceValue	String	True		The effective display preference value.
BancontactAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
BancontactDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
BancontactDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
BancontactDisplayPreferenceValue	String	True		The effective display preference value.
BlikAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
BlikDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
BlikDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
BlikDisplayPreferenceValue	String	True		The effective display preference value.
BoletoAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
BoletoDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
BoletoDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
BoletoDisplayPreferenceValue	String	True		The effective display preference value.
CardAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
CardDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
CardDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
CardDisplayPreferenceValue	String	True		The effective display preference value.
CartesBancairesAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
CartesBancairesDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
CartesBancairesDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
CartesBancairesDisplayPreferenceValue	String	True		The effective display preference value.
CashappAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
CashappDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
CashappDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
CashappDisplayPreferenceValue	String	True		The effective display preference value.
CustomerBalanceAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
CustomerBalanceDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
CustomerBalanceDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
CustomerBalanceDisplayPreferenceValue	String	True		The effective display preference value.
EpsAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
EpsDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
EpsDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
EpsDisplayPreferenceValue	String	True		The effective display preference value.
FpxAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
FpxDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
FpxDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
FpxDisplayPreferenceValue	String	True		The effective display preference value.
GiropayAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
GiropayDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
GiropayDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
GiropayDisplayPreferenceValue	String	True		The effective display preference value.
GooglePayAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
GooglePayDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
GooglePayDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
GooglePayDisplayPreferenceValue	String	True		The effective display preference value.
GrabpayAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
GrabpayDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
GrabpayDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
GrabpayDisplayPreferenceValue	String	True		The effective display preference value.
IdealAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
IdealDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
IdealDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
IdealDisplayPreferenceValue	String	True		The effective display preference value.
JcbAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
JcbDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
JcbDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
JcbDisplayPreferenceValue	String	True		The effective display preference value.
KlarnaAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
KlarnaDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
KlarnaDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
KlarnaDisplayPreferenceValue	String	True		The effective display preference value.
KonbiniAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
KonbiniDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
KonbiniDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
KonbiniDisplayPreferenceValue	String	True		The effective display preference value.
LinkAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
LinkDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
LinkDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
LinkDisplayPreferenceValue	String	True		The effective display preference value.
MobilepayAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
MobilepayDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
MobilepayDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
MobilepayDisplayPreferenceValue	String	True		The effective display preference value.
MultibancoAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
MultibancoDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
MultibancoDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
MultibancoDisplayPreferenceValue	String	True		The effective display preference value.
OxxoAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
OxxoDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
OxxoDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
OxxoDisplayPreferenceValue	String	True		The effective display preference value.
P24Available	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
P24DisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
P24DisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
P24DisplayPreferenceValue	String	True		The effective display preference value.
PaynowAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
PaynowDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
PaynowDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
PaynowDisplayPreferenceValue	String	True		The effective display preference value.
PaypalAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
PaypalDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
PaypalDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
PaypalDisplayPreferenceValue	String	True		The effective display preference value.
PromptpayAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
PromptpayDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
PromptpayDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
PromptpayDisplayPreferenceValue	String	True		The effective display preference value.
RevolutPayAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
RevolutPayDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
RevolutPayDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
RevolutPayDisplayPreferenceValue	String	True		The effective display preference value.
SepaDebitAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
SepaDebitDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
SepaDebitDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
SepaDebitDisplayPreferenceValue	String	True		The effective display preference value.
SofortAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
SofortDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
SofortDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
SofortDisplayPreferenceValue	String	True		The effective display preference value.
SwishAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
SwishDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
SwishDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
SwishDisplayPreferenceValue	String	True		The effective display preference value.
TwintAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
TwintDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
TwintDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
TwintDisplayPreferenceValue	String	True		The effective display preference value.
UsBankAccountAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
UsBankAccountDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
UsBankAccountDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
UsBankAccountDisplayPreferenceValue	String	True		The effective display preference value.
WechatPayAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
WechatPayDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
WechatPayDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
WechatPayDisplayPreferenceValue	String	True		The effective display preference value.
ZipAvailable	Boolean	True		Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
ZipDisplayPreferenceOverridable	Boolean	True		For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
ZipDisplayPreferencePreference	String	False		The account's display preference. The allowed values are none, off, on.
ZipDisplayPreferenceValue	String	True		The effective display preference value.

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

ApplePayLaterDisplayPreferencePreference

String

The account’s preference for whether or not to display this payment method. Used only in INSERT and UPDATE operations.

The allowed values are none, off, on.

PaymentMethods

Create, update and query the available PaymentMethods in Stripe.

Table Specific Information

Select

The Sync App 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 Sync App.

Id support the following operator: =.
CustomerId support the following operator: =.
Type support the following operator: =.
AccountId support the following operator: =.

You can select from the PaymentMethods table with the following queries:

SELECT * FROM PaymentMethods WHERE Id = 'src_1MTIO2SC4snQ4WkOadEObFqk'
SELECT * FROM PaymentMethods WHERE CustomerId = 'cus_N8rO0qc7j1SJJ9'
SELECT * FROM PaymentMethods WHERE CustomerId = 'cus_N8rO0qc7j1SJJ9' AND Type = 'card'
SELECT * FROM PaymentMethods WHERE CustomerId = 'cus_N8rO0qc7j1SJJ9' AND AccountId = 'acct_1MGcyqSC4snQ4WkO'

Insert

To create a new PaymentMethod, at least Type is required:

INSERT INTO PaymentMethods (Type) VALUES ('affirm')
INSERT INTO PaymentMethods (Type, CardExpMonth, CardExpYear, CardNumber, CardCVC, BillingDetailsAddressCity, BillingDetailsAddressCountry, BillingDetailsAddressLine1, BillingDetailsAddressLine2, BillingDetailsAddressPostalCode, BillingDetailsAddressState, BillingDetailsEmail, BillingDetailsName, BillingDetailsPhone) VALUES ('card', '11', '24', '4242424242424242', '531', 'Bengaluru', 'IN', 'Neeladri', 'Ecity', '5601001', 'Karnataka', '[email protected]', 'YOEGSH MANGAL', '7728062870')

Update

To modify a PaymentMethod, specify the PaymentMethods Id and run an Update statement.

UPDATE PaymentMethods SET BillingDetailsAddressCity = 'Jaipur' WHERE Id = 'src_1MSDXZSC4snQ4WkOUER8uzmc'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the Payment Method.
CustomerId	String	True		The Id of the Customer.
BillingDetailsAddressCity	String	False		City, district, suburb, town, or village name for Billing Address.
BillingDetailsAddressCountry	String	False		2-letter country code for Billing Address.
BillingDetailsAddressLine1	String	False		Address line 1 for Billing Address.
BillingDetailsAddressLine2	String	False		Address line 2 for Billing Address.
BillingDetailsAddressPostalCode	String	False		ZIP or postal code for Billing Address.
BillingDetailsAddressState	String	False		State, county, province, or region for Billing Address.
BillingDetailsEmail	String	False		Email address for Billing Address.
BillingDetailsName	String	False		Full name for Billing Address.
BillingDetailsPhone	String	False		Billing phone number (including extension).
MetadataAggregate	String	False		Set of key-value pairs that you can attach to an object.
Type	String	False		The type of the PaymentMethod. The type of PaymentMethods supported are: acss_debit, affirm, afterpay_clearpay, alipay, au_becs_debit, bacs_debit, bancontact, blik, boleto, card, customer_balance, eps, fps, giropay, grabpay, ideal, klarna, konbini, oxxo, p24, paynow, pix, promptpay, sepa_debit, sofort, us_bank_account, wechat_pay, zip. The allowed values are acss_debit, affirm, afterpay_clearpay, alipay, au_becs_debit, bacs_debit, bancontact, blik, boleto, card, card_present, cashapp, customer_balance, eps, fpx, giropay, grabpay, ideal, klarna, konbini, link, oxxo, p24, paynow, paypal, pix, promptpay, revolut_pay, sepa_debit, sofort, us_bank_account, wecha_pay, zip.
Object	String	True		String representing the object type. Objects of the same type share the same value.
AcssDebitBankName	String	True		Bank name for the payment method type acss_debit.
AcssDebitFingerprint	String	True		Uniquely identifies this particular bank account for the payment method type acss_debit.
AcssDebitInstitutionNumber	String	False		Institution number of the customer bank.
AcssDebitLast4	String	True		Last four digits of the bank account number for the payment method type acss_debit.
AcssDebitTransitNumber	String	False		Transit number of the customer bank.
Affirm	String	False		This hash contains details about the Affirm payment method.
AfterpayClearpay	String	False		This hash contains details about the AfterpayClearpay payment method.
Alipay	String	False		This hash contains details about the Alipay payment method.
AuBecsDebitBsbNumber	String	False		Six-digit number identifying bank and branch associated with this bank account.
AuBecsDebitFingerprint	String	True		Uniquely identifies this particular bank account for the payment method type au_becs_debit.
AuBecsDebitLast4	String	True		Last four digits of the bank account number for the payment method type au_becs_debit.
BacsDebitSortCode	String	False		Sort code of the bank account(e.g., 10-20-30). for the payment method type bacs_debit.
BacsDebitLast4	String	True		Uniquely identifies this particular bank account for the payment method type bacs_debit.
BacsDebitFingerprint	String	True		Last four digits of the bank account number for the payment method type bacs_debit.
Bancontact	String	False		This hash contains details about the Bancontact payment method.
Blik	String	False		This hash contains details about the blik payment method.
CardBrand	String	True		Card brand. Can be amex, diners, discover, jcb, mastercard, unionpay, visa, or unknown.
CardChecksAddressLine1Check	String	True		If a address line1 was provided, results of the check, one of pass, fail, unavailable, or unchecked.
CardChecksAddressPostalCodeCheck	String	True		If a address postal code was provided, results of the check, one of pass, fail, unavailable, or unchecked.
CardChecksCvcCheck	String	True		If a CVC was provided, results of the check, one of pass, fail, unavailable, or unchecked.
CardCountry	String	True		Two-letter ISO code representing the country of the card.
CardExpMonth	Integer	False		Two-digit number representing the card expiration month.
CardExpYear	Integer	False		Four-digit number representing the card expiration year.
CardFingerprint	String	True		Uniquely identifies this particular card number.
CardFunding	String	True		Card funding type. Can be credit, debit, prepaid, or unknown.
CardGeneratedFrom	String	True		Details of the original PaymentMethod that created this object.
CardLast4	String	True		The last four digits of the card.
CardNetworksAvailable	String	True		All available networks for the card.
CardNetworksPreferred	String	True		The preferred network for the card.
CardThreeDSecureUsageSupported	Boolean	True		Whether 3D Secure is supported on this card.
CardWallet	String	True		If this Card is part of a card wallet, this contains the details of the card wallet.
CashAppBuyerId	String	True		A unique and immutable identifier assigned by Cash App to every buyer.
CashAppCashTag	String	True		A public identifier for buyers using Cash App.
CustomerBalance	String	False		This hash contains details about the CustomerBalance payment method.
EpsBank	String	False		The customer bank. EPS is an Austria-based bank redirect payment method.
FpxAccountHolderType	String	True		Account holder type for FPX bank. FPX is a Malaysia-based bank redirect payment method.
FpxBank	String	False		The customer bank name and it should be Malaysia-based bank.
GIROPAY	String	False		This hash contains details about the Giropay payment method.
Grabpay	String	False		This hash contains details about the grabpay payment method.
IdealBank	String	False		The customer bank name and it is a Netherlands-based bank redirect payment method.
IdealBic	String	True		Bank Identifier code for Ideal Bank.
Konbini	String	False		This hash contains details about the konbini payment method.
Link	String	False		This hash contains details about the link payment method.
Oxxo	String	False		This hash contains details about the oxxo payment method.
P24Bank	String	False		The customer bank. P24 stands for Przelewy24 is a bank redirect payment method used in Poland.
Paynow	String	False		This hash contains details about the paynow payment method.
Paypal	String	False		This hash contains details about the paypal payment method.
Pix	String	False		This hash contains details about the pix payment method.
Promptpay	String	False		This hash contains details about the promptpay payment method.
RevolutPay	String	False		This hash contains details about the RevolutPay payment method.
SepaDebitBankCode	String	True		Bank Code for SepaDebit.
SepaDebitBranchCode	String	True		Branch Code for SepaDebit.
SepaDebitCountry	String	True		Country for SepaDebit.
SepaDebitFingerprint	String	True		Fingerprint for SepaDebit.
SepaDebitGeneratedFromCharge	String	True		SepaDebit generated from Charge.
SepaDebitGeneratedFromSetupAttempt	String	True		SepaDebit generated from setup attempt.
SepaDebitLast4	String	True		Last 4 digits of IBAN of the Bank Account.
SofortCountry	String	False		Two-letter ISO code representing the country the bank account is located in. Sofort is a bank redirect payment method used in Europe.
UsBankAccountAccountHolderType	String	False		Account holder type: individual or company.
UsBankAccountAccountType	String	False		Account type: checkings or savings. Defaults to checking if omitted.
UsBankAccountBankName	String	True		Bank name.
UsBankAccountFinancialConnectionsAccount	String	False		The ID of a Financial Connections Account to use as a payment method.
UsBankAccountFingerprint	String	True		Fingerprint of UsBank Account.
UsBankAccountLast4	String	True		Last4 digits of the UsBank Account number.
UsBankAccountNetworksPreferred	String	True		Contains information about US bank account networks that can be used. The preferred network.
UsBankAccountNetworksSupported	String	True		Contains information about US bank account networks that can be used. All supported networks.
UsBankAccountRoutingNumber	String	False		Routing number of the bank account.
UsBankAccountStatusDetails	String	True		Contains information about the future reusability of this PaymentMethod.
WechatPay	String	False		This hash contains details about the WechatPay payment method.
Zip	String	False		This hash contains details about the Zip payment method.
Created	Timestamp	True		Time at which the object was created.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
PaypalPayerId	String	True		PayPal account PayerID. PayPal account PayerID.
PaypalPayerEmail	String	True		Owner's email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement.
RadarOptionsSession	String	False		A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
CardDisplayBrand	String	True		The brand to use when displaying the card, this accounts for customer’s brand choice on dual-branded cards. Can be american_express, cartes_bancaires, diners_club, discover, eftpos_australia, interac, jcb, mastercard, union_pay, visa, or other and may contain more values in the future.

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
CardNumber	String	Card Number.
CardCVC	String	Card CVC number.
AcssDebitAccountNumber	String	Customer bank account number. Pre-authorized debit payments are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).
AuBecsDebitAccountNumber	String	The account number for the bank account. BECS Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).
BacsDebitAccountNumber	String	Account number of the bank account that the funds will be debited from. Bacs Direct Debit is used to debit UK bank accounts.
BoletoTaxId	String	The tax ID of the customer. Boleto is a voucher-based payment method used in Brazil.
KlarnaDobDay	String	The day of birth, between 1 and 31 of Customer for paymentmethod type klarna.
KlarnaDobMonth	String	The month of birth, between 1 and 12 of Customer for paymentmethod type klarna.
KlarnaDobYear	String	The four-digit year of birth of Customer for paymentmethod type klarna.
SepaDebitIban	String	IBAN of the bank account. SEPA Direct Debit is used to debit bank accounts within the Single Euro Payments Area (SEPA) region.
UsBankAccountAccountNumber	String	Account number of the bank account. ACH Direct Debit is used to debit US bank accounts through the Automated Clearing House (ACH) payments system.
AccountId	String	The Id of the connected account.

Payouts

Query the available Payouts in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operators: =.
Destination supports the following operators: =.
Status supports the following operators: =.
AccountId supports the following operators: =.
ArrivalDate and Created support the following operators: <, <=, =, >, >=.

You can select from the Payouts table with the following queries:

SELECT * FROM Payouts WHERE Status = 'paid'
SELECT * FROM Payouts WHERE Destination = 'ba_1LylJA2eZvKYlo2CFndhyBc6'
SELECT * FROM Payouts WHERE Created > '2024-01-01'
SELECT * FROM Payouts WHERE ArrivalDate < '2024-08-01'

You can select from the Payouts table with the following queries:

SELECT * FROM Payouts WHERE Status = 'paid'
SELECT * FROM Payouts WHERE Destination = 'ba_1LylJA2eZvKYlo2CFndhyBc6'
SELECT * FROM Payouts WHERE Created > '2024-01-01'
SELECT * FROM Payouts WHERE ArrivalDate < '2024-08-01'
SELECT * FROM Payouts WHERE Currency = 'usd'
SELECT * FROM Payouts WHERE Status = 'failed'

Insert

To create a new Payout Amount, Currency is required. The columns that are not read-only can be inserted optionally.

INSERT INTO Payouts(amount, currency, description, Metadata, StatementDescriptor, Destination, `Method`, sourcetype) VALUES ('20','usd','Weekly commision payout', '[{"order_id":"15426"}]','Commission Payment','ba_1LylJA2eZvKYlo2CFndhyBc6','standard','bitcoin_receiver' )

Update

Update can be executed by specifying Id. The columns that are not read-only can be updated optionally.

UPDATE Payouts SET Metadata='[{\"order_id\":\"25869633\"}]' where id ='po_1OPRUn2eZvKYlo2COA33LQ2S'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the payout.
Object	String	True		String representing the type of the object.
Amount	Integer	False		Amount (in cents) to be transferred to the bank account or debit card.
ArrivalDate	Datetime	True		Date the payout is expected to arrive in the bank. .
BalanceTransaction	String	True	BalanceTransactions.Id	The Id of the balance transaction that describes the impact of this payout on the account balance.
Created	Datetime	True		Time of creation.
Currency	String	False		Three-letter ISO currency code.
Description	String	False		The payout description.
Destination	String	False	Accounts.Id	The Id of the bank account or card the payout was sent to.
FailureBalanceTransaction	String	True		If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction.
FailureCode	String	True		Error code explaining reason for payout failure if available.
FailureMessage	String	True		Error code explaining reason for payout failure if available.
Metadata	String	False		Set of key/value pairs that you can attach to an object.
Method	String	False		TThe method used to send this payout. instant is only supported for payouts to debit cards. The allowed values are standard, instant.
SourceType	String	False		The source balance this payout came from. The allowed values are card, bank_account, bitcoin_receiver, alipay_account, fpx.
StatementDescriptor	String	False		Extra information about a payout to be displayed on the bank statement.
Status	String	True		Current status of the payout. The allowed values are paid, pending, in_transit, canceled, failed.
Type	String	True		Can be bank_account or card. The allowed values are bank_account, card.
Automatic	Boolean	True		Returns true if the payout was created by an automated payout schedule, and false if it was requested manually.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
OriginalPayout	String	True		If the payout reverses another, this is the ID of the original payout.
ReversedBy	String	True		If the payout was reversed, this is the ID of the payout that reverses this payout.
ReconciliationStatus	String	True		If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout. The allowed values are completed, in_progress, not_applicable.

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 to get payouts for

Persons

Usage information for the operation Persons.rsd.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following columns and operators:

Id supports the following operator: =.
Account supports the following operator: =.
RelationshipDirector supports the following operator: =.
RelationshipExecutive supports the following operator: =.
RelationshipOwner supports the following operator: =.
RelationshipLegalGuardian supports the following operator: =.
RelationshipRepresentative supports the following operator: =.

The rest of the filter is executed client-side within the Sync App.

You can select from the Persons table with the following queries:

SELECT * FROM Persons WHERE Id = '123124' AND Account = 'acc_wr3r23r'
SELECT * FROM Persons WHERE Account = 'acc_wr3r23r'
SELECT * FROM Persons WHERE Account = 'acc_wr3r23r' AND RelationshipDirector = 'true'
SELECT * FROM Persons WHERE Account = 'acc_wr3r23r' AND RelationshipExecutive = 'true'
SELECT * FROM Persons WHERE Account = 'acc_wr3r23r' AND RelationshipOwner = 'true'
SELECT * FROM Persons WHERE Account = 'acc_wr3r23r' AND RelationshipPercentOwnership = '35.5'
SELECT * FROM Persons WHERE Account = 'acc_wr3r23r' AND RelationshipRepresentative = '35'
SELECT * FROM Persons WHERE Account = 'acc_wr3r23r' AND RelationshipTitle = 'Owner'

Note:The Persons table does not return data for Standard connected accounts because these accounts are managed directly by the account holders through the Stripe Dashboard. Detailed personal information for these accounts is not accessible through the API. For access to personal data, consider using Express or Custom connected accounts, which allow more control for the platform managing the account.

Insert

To add new details to the Stripe account an Account value is required:

INSERT INTO Persons(Account, RegisteredAddressCity, RegisteredAddressCountry, RegisteredAddressLine1, RegisteredAddressLine2, RegisteredAddressPostalCode, RegisteredAddressState) values('acct_1OOtmyGdCIl7jorZ','jaipur','US','TestLine1','TestLine2','321001','Rajasthan')

Update

To modify details, specify the Person Id and associated Account Id:

UPDATE Persons SET RelationshipDirector='false' WHERE Id='123124' AND Account = 'acc_wr3r23r'

Delete

To delete details, specify the person Id:

DELETE FROM Persons WHERE Id='123124' and AccountId='123445'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the person.
Account [KEY]	String	True		The mode of the Checkout Session.
Created	Datetime	True		The time at which the object was created. Measured in seconds since the Unix epoch.
DobDay	Integer	False		The day of birth, between 1 and 31.
DobMonth	Integer	False		The month of birth, between 1 and 12.
DobYear	Integer	False		The four-digit year of birth.
Email	String	False		The person's email address.
FirstName	String	False		The person's first name.
LastName	String	False		The person's last name.
MaidenName	String	False		The person’s maiden name.
FutureRequirementsAlternatives	String	True		Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
FutureRequirementsCurrentlyDue	String	True		Fields that need to be collected to keep the person's account enabled.
FutureRequirementsErrors	String	True		Fields that are currently_due and need to be collected again because validation or verification failed.
FutureRequirementsEventuallyDue	String	True		Fields that need to be collected, assuming all volume thresholds are reached.
FutureRequirementsPastDue	String	True		Fields that were not collected by the account's requirements.current_deadline.
FutureRequirementsPendingVerification	String	True		Fields that may become required, depending on the results of verification or review.
IdNumber	String	False		The Id number.
IdNumberProvided	Boolean	True		Whether the person's id_number was provided.
IdNumberSecondaryProvided	Boolean	True		Whether the person’s id_number_secondary was provided.
Metadata	String	False		The set of key/value pairs that you can attach to a value list object.
RelationshipDirector	Boolean	False		Whether the person is a director of the account's legal entity.
RelationshipExecutive	Boolean	False		Whether the person has significant responsibility to control, manage, or direct the organization.
RelationshipLegalGuardian	Boolean	False		Whether the person is the legal guardian of the account’s representative.
RelationshipOwner	Boolean	False		Whether the person is an owner of the account's legal entity.
RelationshipPercentOwnership	Double	False		The percent owned by the person of the account's legal entity.
RelationshipRepresentative	Boolean	False		Whether the person is authorized as the primary representative of the account.
RelationshipTitle	String	False		The person's title
RequirementsAlternatives	String	True		Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
RequirementsCurrentlyDue	String	True		Fields that need to be collected to keep the person's account enabled.
RequirementsErrors	String	True		Fields that are currently_due and need to be collected again because validation or verification failed.
RequirementsEventuallyDue	String	True		Fields that need to be collected assuming all volume thresholds are reached.
RequirementsPastDue	String	True		Fields that were not collected by the account's requirements.current_deadline.
RequirementsPendingVerification	String	True		Fields that may become required depending on the results of verification or review. If verification fails, these fields move to eventually_due or currently_due.
SsnLas4	String	False		The last 4 digits of the person's Social Security Number.
SsnLas4Provided	Boolean	True		Whether the last four digits of the person's Social Security Number have been provided (U.S. only).
VerificationAdditionalDocumentBack	String	False		The back of an Id returned by a file upload with a purpose value of identity_document.
VerificationAdditionalDocumentDetails	String	True		A user-displayable string describing the verification state of this document.
VerificationAdditionalDocumentDetailsCode	String	True		A machine-readable code specifying the verification state for this document.
VerificationAdditionalDocumentFront	String	False		The front of an Id returned by a file upload with a purpose value of identity_document.
VerificationDetails	String	True		A user-displayable string describing the verification state for the person.
VerificationDetailsCode	String	True		A machine-readable code specifying the verification state for the person.
VerificationDocumentBack	String	False		The back of an Id returned by a file upload with a purpose value of identity_document.
VerificationDocumentDetails	String	True		A user-displayable string describing the verification state of this document.
VerificationDocumentDetailsCode	String	True		A machine-readable code specifying the verification state for this document.
VerificationDocumentFront	String	False		The front of an Id returned by a file upload with a purpose value of identity_document.
VerificationStatus	String	True		The state of verification for the person. Possible values are unverified, pending, or verified.
AddressCity	String	False		The City of the person.
AddressCountry	String	False		The Country of the person.
AddressLine1	String	False		The Address line 1.
AddressLine2	String	False		The Address line 2.
AddressPostalCode	String	False		The Postal code of the person.
AddressState	String	False		The State of the person.
Phone	String	False		The person’s phone number.
AdditionalTosAcceptancesAccountDate	Datetime	False		Details on the legal guardian’s acceptance of the required Stripe agreements. The Unix timestamp marking when the account representative accepted the service agreement.
AdditionalTosAcceptancesAccountIp	String	False		Details on the legal guardian’s acceptance of the required Stripe agreements. The IP address from which the account representative accepted the service agreement.
AdditionalTosAcceptancesAccountUserAgent	String	False		Details on the legal guardian’s acceptance of the required Stripe agreements. The user agent of the browser from which the account representative accepted the service agreement.
Gender	String	False		The person’s gender (International regulations require either “male” or “female”).
Nationality	String	False		The country where the person is a national.
PoliticalExposure	String	False		Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. The allowed values are existing, none.
RegisteredAddressCity	String	False		The person’s registered address. The City of the person.
RegisteredAddressCountry	String	False		The person’s registered address. The Country of the person.
RegisteredAddressLine1	String	False		The person’s registered address. The Address line 1.
RegisteredAddressLine2	String	False		The person’s registered address. The Address line 2.
RegisteredAddressPostalCode	String	False		The person’s registered address. The Postal code of the person.
RegisteredAddressState	String	False		The person’s registered address. The State of the person.

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
DocumentsCompanyAuthorizationFiles	String	Documents that may be submitted to satisfy various informational requests. One or more documents that demonstrate proof that this person is authorized to represent the company.
DocumentsPassportFiles	String	Documents that may be submitted to satisfy various informational requests. One or more documents showing the person’s passport page with photo and personal data.
DocumentsVisaFiles	String	Documents that may be submitted to satisfy various informational requests. One or more documents showing the person’s visa required for living in the country where they are residing.
FullNameAliases	String	A list of alternate names or aliases that the person is known by.
IdNumberSecondary	String	The person’s secondary ID number, as appropriate for their country, will be used for enhanced verification checks.
PersonToken	String	A person token, used to securely provide details to the person.

Plans

Create, update, delete, and query the available Plans in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id, Active, AccountId, and ProductId support the following operator: =.
Created supports the following operators: <, >, >=, <, <=, =.

You can select:

A plan by specifying its Id:

SELECT * FROM Plans WHERE Id = 'gold'

Plans created after a specific date(Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Plans WHERE Created > '2016-01-03'

Insert

ProductId or ProductName, Currency and Interval columns are required to create a new plan:

INSERT INTO Plans (Active, AggregateUsage, BillingScheme, Currency, Nickname, ProductName, ProductActive, ProductStatementDescriptor, ProductTaxCode, ProductUnitLabel, [Interval], IntervalCount, TrialPeriodDays, UsageType, Tiersmode, TiersAggregate, MetadataAggregate) values (true,'last_ever','tiered','aud','Test2','MYNEWPRODUCT6',true,'Example statement','txcd_30040003','TestLabel','week',3,15,'metered','volume','[{\"up_to\":\"inf\",\"flat_amount_decimal\":\"356\",\"unit_amount_decimal\":\"785\"}]','[{\"Test\":\"123\",\"Test1\":\"456\",\"Test2\":\"789\"}]'

Note: There are multiple ways to create a new plan. For more details, refer to the API documentation.

Update

To update a plan, specify the Id:

UPDATE Plans SET Active = false, MetadataAggregate = '[{\"order_id\":\"124\"}]', Nickname = 'updatednickname', TrialPeriodDays = 25, ProductId = 'prod_PDnk45sKPO58Cy' where Id = 'plan_PDnshHrzdDXeUE'

Delete

To delete a plan, specify the Id:

DELETE FROM Plans WHERE Id = '123easdas5'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the plan.
Active	Boolean	False		Whether the plan can be used for new purchases.
Amount	Integer	False		The amount in cents to be charged on the interval specified.
AmountDecimal	Decimal	False		The decimal value of amount in cents to be charged on the interval specified.
UnitAmount	Decimal	True		The amount in cents to be charged on the interval specified.
AggregateUsage	String	False		Specifies a usage aggregation strategy for plans of usage_type=metered. The allowed values are last_during_period, last_ever, max, sum.
BillingScheme	String	False		Describes how to compute the price per period. Either per_unit or tiered. The allowed values are per_unit, tiered.
Created	Datetime	True		The creation date.
Currency	String	False		Currency in which subscription will be charged.
Nickname	String	False		A brief description of the plan, hidden from customers.
ProductId	String	False		The product whose pricing this plan determines.
ProductName	String	False		The product whose pricing this plan determines. The product’s name, meant to be displayable to the customer.
ProductActive	Boolean	False		The product whose pricing this plan determines. Whether the product is currently available for purchase. Defaults to true.
ProductMetadata	String	False		The product whose pricing this plan determines. Set of key-value pairs that you can attach to an object.
ProductStatementDescriptor	String	False		The product whose pricing this plan determines. An arbitrary string to be displayed on your customer’s credit card or bank statement.
ProductTaxCode	String	False		The product whose pricing this plan determines. A tax code ID.
ProductUnitLabel	String	False		The product whose pricing this plan determines. A label that represents units of this product.
LiveMode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Interval	String	False		One of day, week, month or year. The frequency with which a subscription should be billed. The allowed values are day, week, month, year.
IntervalCount	Integer	False		The number of intervals (specified in the interval property) between each subscription billing. For example, interval=month and interval_count=3 bills every 3 months.
TrialPeriodDays	Integer	False		Number of trial period days granted when subscribing a customer to this plan. Null if the plan has no trial period.
MetadataAggregate	String	False		Number of trial period days granted when subscribing a customer to this plan. Null if the plan has no trial period.
TiersAggregate	String	False		Each element represents a pricing tier.
TiersMode	String	False		Defines if the tiering price should be graduated or volume based.
TransformUsageDivideBy	Integer	False		Divide usage by this number.
TransformUsageRound	String	False		After division, either round the result up or down.
UsageType	String	False		Configures how the quantity per period should be determined. Can be either metered or licensed.
ProductDefaultPrice	String	True		The product whose pricing this plan determines. The ID of the Price object that is the default price for this product.
ProductDescription	String	True		The product whose pricing this plan determines. The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
ProductObject	String	True		The product whose pricing this plan determines. String representing the object’s type. Objects of the same type share the same value.
ProductCreated	Datetime	True		The product whose pricing this plan determines. String representing the object’s type. Time at which the object was created.
ProductImages	String	True		The product whose pricing this plan determines. A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
ProductLivemode	Boolean	True		The product whose pricing this plan determines. Has the value true if the object exists in live mode or the value false if the object exists in test mode.
ProductMarketingFeatures	String	True		The product whose pricing this plan determines. A list of up to 15 marketing features for this product. These are displayed in pricing tables.
ProductPackageDimensionsHeight	Double	True		The product whose pricing this plan determines. Height, in inches.
ProductPackageDimensionsLength	Double	True		The product whose pricing this plan determines. Length, in inches.
ProductPackageDimensionsWeight	Double	True		The product whose pricing this plan determines. Weight, in inches.
ProductPackageDimensionsWidth	Double	True		The product whose pricing this plan determines. Width, in inches.
ProductShippable	Boolean	True		The product whose pricing this plan determines. Whether this product is shipped (i.e., physical goods).
ProductUpdated	Datetime	True		The product whose pricing this plan determines. Time at which the object was last updated.
ProductUrl	String	True		The product whose pricing this plan determines. A URL of a publicly-accessible webpage for this product.

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 to get plans for.

Prices

Create, update, and query the available prices in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
Active supports the following operator: =.
Created supports the following operators: =, >=, <=, >, <.
Currency supports the following operator: =.
LookupKey supports the following operator: =.
MetadataAggregate supports the following operator: =.
Product supports the following operator: =.
RecurringInterval supports the following operator: =.
RecurringUsageType supports the following operator: =.
Type supports the following operator: =.
AccountId supports the following operator: =.

You can select:

Price by specifying its Id:

SELECT * FROM Prices WHERE Id = 'price_1HeiRmATXQzBWNrlQOSoEytH'

Prices created after a specific date(Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Plans WHERE Created > '2016-01-03'

Insert

ProductId or ProductName, and Currency are required to create a price:

INSERT INTO Prices (Active, BillingScheme, LookupKey, Nickname, Currency, Product, RecurringInterval, RecurringAggregateUsage, RecurringIntervalCount, RecurringUsageType, TransformQuantityDivideBy, TransformQuantityRound, UnitAmount, TaxBehavior) VALUES (true, 'per_unit', 'def', 'test_insert', usd, 'prod_P8AoSHyvPlfYMp', 'month', 'max', 3, 'metered', 2, 'up', 10, 'unspecified')

INSERT INTO Prices (Active, BillingScheme, Currency, LookupKey, MetadataAggregate, Nickname, Product, RecurringInterval, RecurringAggregateUsage, RecurringIntervalCount, RecurringUsageType, Tiersmode, TiersAggregate) values (false, 'tiered', 'usd', 'TestKey5', '[{\"A\":\"BCD\",\"E\":\"FGH\",\"I\":\"JKL\"}]', 'Nickname1', 'prod_PDm7du7ErjMSwY', 'week', 'last_during_period', 5, 'metered', 'volume', '[{\"up_to\":\"inf\",\"flat_amount_decimal\":\"356\",\"unit_amount_decimal\":\"785\"}]')

Update

To update a price, specify the Id:

UPDATE Prices SET Active = false, MetadataAggregate = '{\"title\" : \"test price\"}'  WHERE Id = 'price_1HeiRmATXQzBWNrlQOSoEytH'

Delete

Delete is not supported.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the price.
Active	Boolean	False		Whether the price can be used for new purchases.
BillingScheme	String	False		Describes how to compute the price per period.
Created	Datetime	True		The creation date.
Currency	String	False		Currency in which subscription will be charged.
CustomUnitAmountEnabled	Boolean	False		Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
CustomUnitAmountMaximum	Integer	False		The maximum unit amount the customer can specify for this item.
CustomUnitAmountMinimum	Integer	False		The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
CustomUnitAmountPreset	Integer	False		The starting unit amount which can be updated by the customer.
LookupKey	String	False		A lookup key used to retrieve prices dynamically from a static string.
MetadataAggregate	String	False		Set of key-value pairs that you can attach to an object.
Nickname	String	False		A brief description of the plan, hidden from customers.
Product	String	False	Products.Id	The Id of the product this price is associated with.
ProductDataName	String	False		These fields can be used to create a new product that this price will belong to. The product's name, meant to be displayable to the customer.
ProductDataActive	Boolean	False		These fields can be used to create a new product that this price will belong to. Whether the product is currently available for purchase. Defaults to true.
ProductDataMetadata	String	False		These fields can be used to create a new product that this price will belong to. Set of key-value pairs that you can attach to an object.
ProductDataStatementDescriptor	String	False		These fields can be used to create a new product that this price will belong to. An arbitrary string to be displayed on your customer's credit card or bank statement.
ProductDataTaxCode	String	False		These fields can be used to create a new product that this price will belong to. A tax code ID.
ProductDataUnitLabel	String	False		These fields can be used to create a new product that this price will belong to. A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
RecurringInterval	String	False		The frequency at which a subscription is billed. One of day, week, month or year. The allowed values are day, month, week, year.
RecurringAggregateUsage	String	False		Specifies a usage aggregation strategy for prices of usage_type=metered.
RecurringIntervalCount	Integer	False		The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
RecurringUsageType	String	False		Configures how the quantity per period should be determined. Can be either metered or licensed. Defaults to licensed. The allowed values are licensed, metered.
Type	String	True		Value is either 'one_time' or 'recurring' depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. The allowed values are one_time, recurring.
TiersAggregate	String	False		Array of elements representing a pricing tier.
TiersMode	String	False		Defines if the tiering price should be graduated or volume based.
TransformQuantityDivideBy	Integer	False		Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers. Divide usage by this number.
TransformQuantityRound	String	False		Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers. After division, either round the result up or down.
UnitAmount	Integer	False		The unit amount in paise to be charged, represented as a whole integer if possible.
UnitAmountDecimal	String	False		The unit amount in paise to be charged, represented as a decimal string
Object	String	True		String representing the object's type. Objects of the same type share the same value.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
TaxBehavior	String	False		Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
ProductDataDefaultPrice	String	True		These fields can be used to view the fields of the product that this price will belong to. The ID of the Price object that is the default price for this product.
ProductDataDescription	String	True		These fields can be used to view the fields of the product that this price will belong to. The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
ProductDataObject	String	True		These fields can be used to view the fields of the product that this price will belong to. String representing the object’s type. Objects of the same type share the same value.
ProductDataCreated	Datetime	True		These fields can be used to view the fields of the product that this price will belong to. String representing the object’s type. Time at which the object was created.
ProductDataImages	String	True		These fields can be used to view the fields of the product that this price will belong to. A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
ProductDataLivemode	Boolean	True		These fields can be used to view the fields of the product that this price will belong to. Has the value true if the object exists in live mode or the value false if the object exists in test mode.
ProductDataMarketingFeatures	String	True		These fields can be used to view the fields of the product that this price will belong to. A list of up to 15 marketing features for this product. These are displayed in pricing tables.
ProductDataPackageDimensionsHeight	Double	True		These fields can be used to view the fields of the product that this price will belong to. Height, in inches.
ProductDataPackageDimensionsLength	Double	True		These fields can be used to view the fields of the product that this price will belong to. Length, in inches.
ProductDataPackageDimensionsWeight	Double	True		These fields can be used to view the fields of the product that this price will belong to. Weight, in inches.
ProductDataPackageDimensionsWidth	Double	True		These fields can be used to view the fields of the product that this price will belong to. Width, in inches.
ProductDataShippable	Boolean	True		These fields can be used to view the fields of the product that this price will belong to. Whether this product is shipped (i.e., physical goods).
ProductDataUpdated	Datetime	True		These fields can be used to view the fields of the product that this price will belong to. Time at which the object was last updated.
ProductDataUrl	String	True		These fields can be used to view the fields of the product that this price will belong to. A URL of a publicly-accessible webpage for this product.

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 to get prices for.
TransferLookupKey	Boolean	If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.

Products

Query the available products in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
Active supports the following operator: =.
Created supports the following operators: <, <=, =, >, >=.
Shippable supports the following operator: =.
Type supports the following operator: =.
Url supports the following operator: =.
Description supports the following operator: =.
Name supports the following operator: =.
Metadata supports the following operator: =.

You can select:

A product by specifying its Id:

SELECT * FROM Products WHERE Id = '12345678'

Multiple products by specifying their Ids:

SELECT * FROM Products WHERE Id IN ('12345678', '123456789', '123456788',)

Products that can be shipped:

SELECT * FROM Products WHERE Shippable = 'true'

Products for a given URL:

SELECT * FROM Products WHERE URL = '/v1/skus?product=1234\u0026active=true'

Active products:

SELECT * FROM Products WHERE Active = True

Products created after a certain date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Products WHERE Created > '12/1/2015'

Insert

A name is required to create a product:

INSERT INTO Products(Name, Images, FeaturesAggregate, MetadataAggregate) values ('asdwd','[\"http://da.cs/fs.jpg\",\"http://da.cs/fss.jpg\"]','[{\"name\":\"asdsa\"}]','[{\"nsame\":\"asdsa\"}]')

Update

To update a product, specify the Id:

Update Products set Name = 'fafs' where id = 'prod_PEcZQqWgJzbBCW'

Delete

To delete a product, specify the Id:

Delete Products where id = 'prod_PEcZQqWgJzbBCW'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		ID of product.
Active	Boolean	False		Whether or not the product is currently available for purchase. afterwards stripe:version = 2016-06-15 setting active to false no longer marks the product's SKUs as inactive.
FeaturesAggregate	String	False		A list of up to 5 attributes that each SKU can provide value.
Created	Datetime	True		The time when product is created.
DefaultPrice	String	False		The ID of the Price object that is the default price for this product. Can be used in Update.
Description	String	False		The product's description, meant to be displayable to the customer.
Name	String	False		The product's name, meant to be displayable to the customer.maximum character length limit of 250
PackageDimensionsHeight	Double	False		The height dimension of this product for shipping purposes.
PackageDimensionsLength	Double	False		The length dimension of this product for shipping purposes.
PackageDimensionsWeight	Double	False		The weight dimension of this product for shipping purposes.
PackageDimensionsWidth	Double	False		The width dimension of this product for shipping purposes.
Shippable	Boolean	False		Whether this product is a shipped good.
StatementDescriptor	String	False		Extra information about a charge for the credit card statement of the customer.
Updated	Datetime	True		The last updated time.
Type	String	True		The type of the product.
Url	String	False		The URL of a publicly-accessible webpage for this product.
TaxCode	String	False		A tax code ID.
Livemode	Boolean	True		Tells if the dispute is in livemode.
MetadataAggregate	String	False		Set of key-value pairs
Object	String	True		String representing the object's type. Objects of the same type share the same value.
UnitLabel	String	False		A label that represents units of this product in Stripe and on customers receipts and invoices. When set, this will be included in associated invoice line item descriptions.
Images	String	False		A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

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 to get products for.

PromotionCodes

Creates, updates, and retrieves a promotion code that represents a customer-redeemable code for a coupon.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following column and operator:

Id supports the following operator: =.
Active supports the following operator: =.
Code supports the following operator: =.
CouponId supports the following operator: =.
Created supports the following operators: =,>,>=,<,<=.
Customer supports the following operator: =.
AccountId supports the following operator: =.

The rest of the filter is executed client-side within the Sync App.

You can select from the PromotionCodes table with the following queries:

SELECT * FROM PromotionCodes
SELECT * FROM PromotionCodes WHERE Id = '123124'

Insert

To create a promotion code, the CouponId is required:

INSERT INTO PromotionCodes (Active, Code, CouponId, Customer, MaxRedemptions) values ('true', 'FIRST5', 'WN3VpE01', 'cus_NBs3z63zmfCJy1' ,4)

INSERT INTO PromotionCodes (Code, Active, Customer, CouponId, Metadata, Expiresat, MaxRedemptions, RestrictionsFirstTimeTransaction, RestrictionsMinimumAmount, RestrictionsMinimumAmountCurrency) values ('TestCode', true, 'cus_PE90A5xYP8TpeM', 'WG4hYi8e', '[{"A":"BCD","E":"FGH","I":"JKL"}]', '2023-12-30 12:40:20', 15, true, 25, 'eur')

Update

To modify a promotion code, specify the code Id:

UPDATE PromotionCodes SET Active='false' WHERE id='123124'

Delete

Delete is not supported.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the promotion code.
Active	Boolean	False		Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
Code	String	False		The customer-facing code.
CouponAmountOff	Integer	True		The amount (in the currency specified) that is taken off the subtotal of any invoices for this customer.
CouponCreated	Datetime	True		The time at which the coupon was created.
CouponCurrency	String	True		If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
CouponDuration	String	True		One of forever, once, and repeating.
CouponDurationInMonths	Integer	True		If duration is repeating, the number of months the coupon applies. The value is Null if coupon duration is forever or once.
CouponId	String	False		The Id of the coupon.
CouponLivemode	Boolean	True		true if the object is in live mode andfalse if in test mode.
CouponMaxRedemptions	Integer	True		The maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
CouponMetadata	String	True		The set of key-value pairs that you can attach to a coupon.
CouponName	String	True		Name of the coupon displayed to customers.
CouponPercentOff	Double	True		The percent to be taken off the subtotal of any invoices for this customer for the duration of the coupon.
CouponRedeemBy	Datetime	True		The date after which the coupon can no longer be redeemed.
CouponTimesRedeemed	Integer	True		The number of times this coupon has been applied to a customer.
CouponAppliesToProducts	Integer	True		Contains information about what this coupon applies to. A list of product IDs this coupon applies to.
CouponValid	Boolean	True		Whether this coupon can still be applied to a customer, taking the above properties into account .
Created	Datetime	True		The time at which the object was created. Measured in seconds since the Unix epoch.
Customer	String	False		The customer that this promotion code can be used by.
ExpiresAt	Datetime	False		The date at which the promotion code can no longer be redeemed.
Livemode	Boolean	True		true if the object is in live mode andfalse if in test mode.
MaxRedemptions	Integer	False		The maximum number of times this promotion code can be redeemed.
Metadata	String	False		The set of key/value pairs that you can attach to a value list object.
RestrictionsCurrencyOptions	String	False		Promotion codes defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
RestrictionsFirstTimeTransaction	Boolean	False		A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices.
RestrictionsMinimumAmount	Integer	False		The minimum amount required to redeem this Promotion Code into a Coupon.
RestrictionsMinimumAmountCurrency	String	False		A three-letter ISO code for minimum_amount.
TimesRedeemed	Integer	True		The number of times this promotion code has been used.

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 to get promotion code for.

Quotes

Creates, updates, and queries the quotes available.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following columns and operators:

Id supports the following operator: =.
CustomerId supports the following operator: =.
Status supports the following operator: =.
TestClock supports the following operator: =.

The rest of the filter is executed client-side within the Sync App.

You can select from the Quotes table with the following queries:

SELECT * FROM Quotes WHERE Id = '123124'
SELECT * FROM Quotes WHERE CustomerId = 'cus_NVasad'
SELECT * FROM Quotes WHERE Status = 'draft'
SELECT * FROM Quotes WHERE TestClock = 'clock_id'

Insert

To create a quote for the invoice:

INSERT INTO Quotes (AutomaticTaxEnabled, CollectionMethod, CustomerId, Description, InvoiceSettingsDaysUntilDue, Metadata, SubscriptionDataTrialPeriodDays) values ('false', 'send_invoice', 'cus_NBs3z63zmfCJy1', 'Thanks for using YMBusiness!!', 25, '{"name":"test name 2", "surname":"test surname", "age" : "23"}', 20)

INSERT INTO Quotes (DefaultTaxRates, FromQuote, Discounts, TransferData, LineItems) VALUES ('[\"txr_1OL7oy2eZvKYlo2CLylDtkiI\",\"txr_1OL7oo2eZvKYlo2CHliiOEZT\"]', '{\"quote\":\"qt_1N6vEL2eZvKYlo2CwySMFZbA\",\"is_revision\":\"true\"}', '{\"coupon\":\"test1\"}', '{\"destination\":\"acc_123566677\",\"amount\":\"440\",\"amount_percent\":\"23\"}', '[{\"price\":\"price_1OM02h2eZvKYlo2CiiTU7dCm\",\"quantity\":\"10\"}]')

Update

To modify a quote, specify the quote Id:

UPDATE Quotes SET InvoiceSettingsDaysUntilDue = 20 WHERE Id='123124'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the quotes.
AmountSubtotal	Integer	True		The total before any discounts or taxes are applied.
AmountTotal	Integer	True		The total after discounts and taxes are applied.
Application	String	True		The Id of the Connect Application that created the quote.
ApplicationFeeAmount	Integer	False		The amount of the application fee.
ApplicationFeePercent	Double	False		A non-negative decimal between 0 and 100, with at most two decimal places.
AutomaticTaxEnabled	Boolean	False		Automatically calculates taxes.
AutomaticTaxStatus	String	True		The status of the most recent automated tax calculation for this quote.
CollectionMethod	String	False		The method to collect charge money, either charge_automatically or send_invoice.
ComputedRecurring	String	True		The definitive totals and line items the customer is charged on a recurring basis.
ComputedUpfrontAmountSubtotal	Integer	True		The total before any discounts or taxes are applied.
ComputedUpfrontAmountTotal	Integer	True		The total after discounts and taxes are applied.
ComputedUpfrontTotalDetailsAmountDiscount	Integer	True		The sum of all the discounts.
ComputedUpfrontTotalDetailsAmountShipping	Integer	True		The sum of all the shipping amounts.
ComputedUpfrontTotalDetailsAmountTax	Integer	True		The sum of all the tax amounts.
Created	Datetime	True		The time at which the object was created. Measured in seconds since the Unix epoch.
Currency	String	True		A three-letter ISO currency code, in lowercase.
CustomerId	String	False		The Id of the customer.
DefaultTaxRates	String	False		The tax rates applied to this quote.
Description	String	False		A description that is displayed on the quote PDF.
Discounts	String	False		The discounts applied to this quote.
ExpiresAt	Datetime	False		The date on which the quote is canceled if in open or draft status.
Footer	String	False		A footer that is displayed on the quote PDF.
FromQuote	String	False		Details of the quote that was cloned.
Header	String	False		A header that is displayed on the quote PDF.
InvoiceId	String	True		The Id of the invoice that was created from this quote.
InvoiceSettingsDaysUntilDue	Integer	False		The number of days within which a customer must pay invoices generated by this quote.
Livemode	Boolean	True		true if the object is in live mode andfalse if in test mode.
LineItems	String	False		The line items representing what is being sold. Each line item represents an item being sold.
Metadata	String	False		The set of key/value pairs that you can attach to a value list object.
Number	String	True		A unique number that identifies this particular quote.
OnBehalfOf	String	False		The account on behalf of which to charge.
Status	String	True		The status of the quote.
StatusTransitionsAcceptedAt	Datetime	True		The time that the quote was accepted.
StatusTransitionsCanceledAt	Datetime	True		The time that the quote was canceled.
StatusTransitionsFinalizedAt	Datetime	True		The time that the quote was finalized.
Subscription	String	True		The subscription that was created or updated from this quote.
SubscriptionDataDescription	String	False		The subscription's description, meant to be displayable to the customer.
SubscriptionDataEffectiveDate	Datetime	False		When creating a new subscription, the date of which the subscription schedule starts after the quote is accepted.
SubscriptionDataTrialPeriodDays	Integer	False		An integer representing the number of trial period days before the customer is charged for the first time.
SubscriptionSchedule	String	True		The subscription schedule that was created or updated from this quote.
TestClock	String	False		The Id of the test clock this quote belongs to.
TotalDetailsAmountDiscount	Integer	True		The sum of all the discounts.
TotalDetailsAmountShipping	Integer	True		The sum of all the shipping amounts.
TotalDetailsAmountTax	Integer	True		The sum of all the tax amounts.
TransferData	String	False		The account (if any) the payments are attributed to for tax reporting, and where funds from each payment are transferred to for each of the invoices.
AutomaticTaxLiabilityAccount	String	False		The connected account being referenced when type is account.
AutomaticTaxLiabilityType	String	False		Type of the account referenced.
InvoiceSettingsIssuerAccount	String	False		The connected account being referenced when type is account.
InvoiceSettingsIssuerType	String	False		Type of the account referenced. The allowed values are account, self.
SubscriptionDataMetadata	String	False		Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in line_items, this field will be passed to the resulting subscription’s metadata field. If subscription_data.effective_date is used, this field will be passed to the resulting subscription schedule’s phases.metadata field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.

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 for which to get a quote.

Refunds

Create and query the available refunds in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id, Charge, PaymentIntent and AccountId support the following operators: =.
Created support the following operators: <, >, >=, <, <=, =.

You can select:

A refund by specifying its Id:

SELECT * FROM Refunds WHERE Id = 're_19keFRGOsuAdslZgO7zSbS2j'

Refunds associated with a specific charge:

SELECT * FROM Refunds WHERE Charge = 'MyChargeId'

Insert

To insert a refund, provide a specifc charge:

INSERT INTO Refunds (Charge, Amount, Reason) VALUES ('ch_fj57lKDg460322552g', 40, 'duplicate')

INSERT INTO Refunds (Charge, Amount, Reason, MetadataAggregate) values ('ch_3LrL0PHWDgcyHde00jCW5AYz', 100, 'duplicate', '[{\"A\":\"BCD\",\"E\":\"FGH\",\"I\":\"JKL\"}]')

Update

UPDATE is not supported.

Delete

Delete is not supported.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the refund.
Charge	String	False		The Id of the charge that was refunded.
Amount	Integer	False		The Amount, in cents.
Status	String	True		The status of the refund.
BalanceTransaction	String	True		The balance transaction that describes the impact on your account balance.
Created	Datetime	True		The refund datetime.
Currency	String	True		Three-letter ISO code representing the currency.
Reason	String	False		The reason for the refund.
ReceiptNumber	String	True		This is the transaction number that appears on email receipts sent for this refund.
MetadataAggregate	String	False		The refund metadata object.
Description	String	True		An arbitrary string attached to the object. Often useful for displaying to users.
PaymentIntent	String	False		ID of the PaymentIntent that was refunded.
Object	String	True		String representing the object's type. Objects of the same type share the same value.
FailureBalanceTransaction	String	True		If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
FailureReason	String	True		If the refund failed, the reason for refund failure if known. The allowed values are lost_or_stolen_card, expired_or_canceled_card, or unknown..
NextAction	String	True		This property will describe what the refund needs in order to continue processing.
SourceTransferReversal	String	True		The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details.
TransferReversal	String	True		If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.
InstructionsEmail	String	True		For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.
DestinationDetailsAffirm	String	True		If this is a affirm refund, this hash contains the transaction specific details of the affirm refund method.
DestinationDetailsAfterpayClearpay	String	True		If this is a afterpay_clearpay refund, this hash contains the transaction specific details of the afterpay_clearpay refund method.
DestinationDetailsAlipay	String	True		If this is a alipay refund, this hash contains the transaction specific details of the alipay refund method.
DestinationDetailsAmazonPay	String	True		If this is a amazon_pay refund, this hash contains the transaction specific details of the amazon_pay refund method.
DestinationDetailsAuBankTransfer	String	True		If this is a au_bank_transfer refund, this hash contains the transaction specific details of the au_bank_transfer refund method.
DestinationDetailsBlikReference	String	True		If this is a blik refund, this contains the reference assigned to the refund.
DestinationDetailsBlikReferenceStatus	String	True		If this is a blik refund, this contains the status of the reference on the refund. This can be pending, available or unavailable.
DestinationDetailsBrBankTransferReference	String	True		If this is a br_bank_transfer refund, this contains the reference assigned to the refund.
DestinationDetailsBrBankTransferReferenceStatus	String	True		If this is a br_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable.
DestinationDetailsCardReference	String	True		If this is a card refund, this contains the value of the reference number assigned to the refund.
DestinationDetailsCardReferenceStatus	String	True		If this is a card refund, this contains the status of the reference number on the refund. This can be pending, available or unavailable.
DestinationDetailsCardReferenceType	String	True		If this is a card refund, this contains the type of the reference number assigned to the refund.
DestinationDetailsCardType	String	True		If this is a card refund, this contains the type of refund. This can be refund, reversal, or pending.
DestinationDetailsCashapp	String	True		If this is a cashapp refund, this hash contains the transaction specific details of the cashapp refund method.
DestinationDetailsCustomerCashBalance	String	True		If this is a customer_cash_balance refund, this hash contains the transaction specific details of the customer_cash_balance refund method.
DestinationDetailsEps	String	True		If this is a eps refund, this hash contains the transaction specific details of the eps refund method.
DestinationDetailsEuBankTransferReference	String	True		If this is a eu_bank_transfer refund, this contains the reference assigned to the refund.
DestinationDetailsEuBankTransferReferenceStatus	String	True		If this is a eu_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable.
DestinationDetailsGbBankTransferReference	String	True		If this is a gb_bank_transfer refund, this contains the reference assigned to the refund.
DestinationDetailsGbBankTransferReferenceStatus	String	True		If this is a gb_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable.
DestinationDetailsGiropay	String	True		If this is a giropay refund, this hash contains the transaction specific details of the giropay refund method.
DestinationDetailsGrabpay	String	True		If this is a grabpay refund, this hash contains the transaction specific details of the grabpay refund method.
DestinationDetailsJpBankTransferReference	String	True		If this is a jp_bank_transfer refund, this contains the reference assigned to the refund.
DestinationDetailsJpBankTransferReferenceStatus	String	True		If this is a jp_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable.
DestinationDetailsKlarna	String	True		If this is a klarna refund, this hash contains the transaction specific details of the klarna refund method.
DestinationDetailsMultibancoReference	String	True		If this is a multibanco refund, this contains the reference assigned to the refund.
DestinationDetailsMultibancoReferenceStatus	String	True		If this is a multibanco refund, this contains the status of the reference on the refund. This can be pending, available or unavailable.
DestinationDetailsMxBankTransferReference	String	True		If this is a mx_bank_transfer refund, this contains the reference assigned to the refund.
DestinationDetailsMxBankTransferReferenceStatus	String	True		If this is a mx_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable.
DestinationDetailsP24Reference	String	True		If this is a p24 refund, this contains the reference assigned to the refund.
DestinationDetailsP24ReferenceStatus	String	True		If this is a p24 refund, this contains the status of the reference on the refund. This can be pending, available or unavailable.
DestinationDetailsPaynow	String	True		If this is a paynow refund, this hash contains the transaction specific details of the paynow refund method.
DestinationDetailsPaypal	String	True		If this is a paypal refund, this hash contains the transaction specific details of the paypal refund method.
DestinationDetailsPix	String	True		If this is a pix refund, this hash contains the transaction specific details of the pix refund method.
DestinationDetailsRevolut	String	True		If this is a revolut refund, this hash contains the transaction specific details of the revolut refund method.
DestinationDetailsSofort	String	True		If this is a sofort refund, this hash contains the transaction specific details of the sofort refund method.
DestinationDetailsSwishReference	String	True		If this is a swish refund, this contains the reference assigned to the refund.
DestinationDetailsSwishReferenceStatus	String	True		If this is a swish refund, this contains the status of the reference on the refund. This can be pending, available or unavailable.
DestinationDetailsThBankTransferReference	String	True		If this is a th_bank_transfer refund, this contains the reference assigned to the refund.
DestinationDetailsThBankTransferReferenceStatus	String	True		If this is a th_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable.
DestinationDetailsType	String	True		The type of transaction-specific details of the payment method used in the refund (e.g., card). An additional hash is included on destination_details with a name matching this value. It contains information specific to the refund transaction.
DestinationDetailsUsBankTransferReference	String	True		If this is a us_bank_transfer refund, this contains the reference assigned to the refund.
DestinationDetailsUsBankTransferReferenceStatus	String	True		If this is a us_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable.
DestinationDetailsWechatPay	String	True		If this is a wechat_pay refund, this hash contains the transaction specific details of the wechat_pay refund method.
DestinationDetailsZip	String	True		If this is a zip refund, this hash contains the transaction specific details of the zip refund method.

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 to get refunds for.

ShippingRates

Query the available Shipping rates in Stripe.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following columns and operators:

Id supports the following operator: =.
Active supports the following operator: =.
Created supports the following operator: =,>,>=,<,<=.
AccountId supports the following operator: =.
FixedAmountCurrency supports the following operator: =.

The rest of the filter is executed client-side within the Sync App.

You can select from the ShippingRates table with the following queries:

SELECT * FROM ShippingRates WHERE Id = 'shr_1MHKKGSC4snQ4WkONC7OYQuS'
SELECT * FROM ShippingRates WHERE Id = 'shr_1MHKKGSC4snQ4WkONC7OYQuS' AND AccountId = 'acct_1MGcyqSC4snQ4WkO'

Insert

DisplayName and Type are required to create a ShippingRate:

INSERT INTO ShippingRates(DisplayName,Type,MetadataAggregate,FixedAmountAmount,FixedAmountCurrency) values ('asdsswd','fixed_amount','[{\"nsame\":\"asdsa\"}]',230,'usd')

Update

To update a shipping rate, specify the Id:

UPDATE ShippingRates SET Active = true WHERE Id = 'shr_1OQ9ScCZ8rn6qR6h3H86TWDn'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the Shipping Rates.
Active	Boolean	False		Whether the shipping rate can be used for new purchases. Its default value is true.
Created	Timestamp	True		Time at which the object was created. Measured in seconds since the Unix epoch.
DeliveryEstimateMaximumUnit	String	False		A unit of time.
DeliveryEstimateMaximumValue	Integer	False		Must be greater than 0.
DeliveryEstimateMinimumUnit	String	False		A unit of time.
DeliveryEstimateMinimumValue	Integer	False		Must be greater than 0.
DisplayName	String	False		The name of the shipping rate, meant to be displayable to the customer.
FixedAmountAmount	Integer	False		A non-negative integer in cents representing how much to charge.
FixedAmountCurrency	String	False		Three-letter ISO currency code, in lowercase. Must be a supported currency.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
MetadataAggregate	String	False		Set of key-value pairs
Object	String	True		The Object type.
TaxBehavior	String	False		Whether the rate is considered inclusive of taxes or exclusive of taxes.
TaxCode	String	False		Tax code Id.
Type	String	False		The type of calculation to use on the shipping rate.

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.

SubscriptionItems

Create, update, delete, and query the available subscription items in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id, SubscriptionId and AccountId support the following operator: =.

To query the SubscriptionItems table, the SubscriptionId column is required:

SELECT * FROM SubscriptionItems WHERE SubscriptionId = 'sub_A9WZGVTbvgBJ4t'

Insert

SubscriptionId and PlanId columns are required to create a new subscription item:

INSERT INTO SubscriptionItems (SubscriptionId, PlanId, ProrationDate, Quantity) VALUES ('sub_1OMqdl2eZvKYlo2CIci8bOT8', 'price_1OPjac2eZvKYlo2Cm8XeR5YQ', '2014-12-12', 10)

Update

To update a subscription item, specify its Id:

UPDATE SubscriptionItems SET PlanId = 'price_1OPjac2eZvKYlo2Cm8XeR5YQ', ProrationDate = '2014-12-12', Quantity = 12 WHERE Id = 'si_PDakKMQHunYX0k'

Delete

To delete a subscription item, specify its Id:

DELETE FROM SubscriptionItems WHERE Id = 'sit_A9WZGVTbvgBJ4t'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the subscription item.
SubscriptionId	String	False	Subscriptions.Id	The Id of the subscription.
PlanId	String	False	Plans.Id	The Id of the plan.
PlanActive	Boolean	True		Whether the plan can be used for new purchases.
PlanAggregateUsage	String	True		Specifies a usage aggregation strategy for plans of usage_type=metered.
PlanAmount	Integer	True		The unit amount in cents to be charged, represented as a whole integer if possible.
PlanAmountDecimal	String	True		The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
PlanBillingScheme	String	True		Describes how to compute the price per period.
PlanCreated	Datetime	True		Time at which the object was created. Measured in seconds since the Unix epoch.
PlanCurrency	String	True		Three-letter ISO currency code, in lowercase. Must be a supported currency.
PlanInterval	String	True		The frequency at which a subscription is billed. One of day, week, month or year.
PlanIntervalCount	Integer	True		The number of intervals (specified in the interval attribute) between subscription billings.
PlanLivemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
PlanMetadata	String	True		Set of key-value pairs that you can attach to an object.
PlanMeter	String	True		The meter tracking the usage of a metered price.
PlanNickname	String	True		A brief description of the plan, hidden from customers.
PlanObject	String	True		String representing the object's type. Objects of the same type share the same value.
PlanProduct	String	True		The product whose pricing this plan determines.
PlanTiersMode	String	True		Defines if the tiering price should be graduated or volume based.
PlanTransformUsage	String	True		Apply a transformation to the reported usage or set quantity before computing the amount billed.
PlanTrialPeriodDays	Integer	True		Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.
PlanUsageType	String	True		Configures how the quantity per period should be determined.
Quantity	Double	False		The quantity of the plan to which the customer should be subscribed.
Created	Datetime	True		Creation date.
MetadataAggregate	String	False		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.
PriceId	String	False	Prices.Id	Unique identifier for the price.
PriceActive	Boolean	True		Whether the price can be used for new purchases.
PriceBillingScheme	String	True		Describes how to compute the price per period.
PriceCreated	Datetime	True		The creation date.
PriceCurrency	String	True		Currency in which subscription will be charged.
PriceCustomUnitAmount	String	True		Price custom unit amount.
PriceLivemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
PriceLookupKey	String	True		A lookup key used to retrieve prices dynamically from a static string.
PriceMetadata	String	True		Set of key-value pairs that you can attach to an object.
PriceNickname	String	True		A brief description of the plan, hidden from customers.
PriceObject	String	True		String representing the object's type. Objects of the same type share the same value.
PriceProduct	String	True		The Id of the product this price is associated with.
PriceRecurringAggregateUsage	String	True		Price recurring aggregate usage.
PriceRecurringInterval	String	True		Price recurring interval.
PriceRecurringIntervalCount	Integer	True		Price recurring interval count.
PriceRecurringMeter	String	True		Price recurring meter.
PriceRecurringTrialPeriodDays	Integer	True		Price recurring trial period days.
PriceRecurringUsageType	String	True		Price recurring usage type.
PriceTaxBehaviour	String	True		Price tax behaviour.
PriceTiersMode	String	True		Price tiers mode.
PriceTransformQuantity	String	True		Price transform quantity.
PriceType	String	True		Price type.
PriceUnitAmount	Integer	True		Price unit amount.
PriceUnitAmountDecimal	String	True		Price unit amount decimal.
Object	String	True		String representing the object's type. Objects of the same type share the same value.
BillingThresholdsUsageGte	Integer	False		Usage threshold that triggers the subscription to create an invoice
TaxRatesAggregate	String	False		The tax rates which apply to this subscription_item. When set, the default_tax_rates on the subscription do not apply to this subscription_item.
Discounts	String	False		The coupons to redeem into discounts for the subscription item.

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
IsProrate	Boolean	Flag indicating whether to prorate switching plans during a billing cycle.
ProrationDate	Date	If set, the proration will be calculated as though the subscription was updated at the given time.
PaymentBehavior	String	Payment Behavior. Valid for INSERT, DELETE and UPDATE. The allowed values are allow_incomplete, default_incomplete, error_if_incomplete, pending_if_incomplete.
ProrationBehavior	String	Determines how to handle prorations when the billing cycle changes. Valid for INSERT, DELETE and UPDATE. The allowed values are always_invoice, create_prorations, none.
AccountId	String	The Id of the connected account to get subscription items for

Subscriptions

Create, update, delete, and query the available Subscriptions in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id, CustomerId, PlanId, Status, MetadataAggregate, AutomaticTaxEnabled, CollectionMethod, TestClock and AccountId support the following operator: =.
CreatedAt supports the following operators: =, !=, >, >=, <, <=.

You can select:

A subscription by specifying its Id:

SELECT * FROM Subscriptions WHERE Id = 'mySubscriptionId'

Subscriptions created after a specific date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Subscriptions WHERE CreatedAt > '2016-01-03'

Subscriptions that belong to a customer:

SELECT * FROM Subscriptions WHERE CustomerId = 'cus_12345678'

Subscriptions that belong to a plan:

SELECT * FROM Subscriptions WHERE PlanId = 'myPlanId'

Subscriptions with a specific status:

SELECT * FROM Subscriptions WHERE Status = 'active'

Subscriptions with metadata:

SELECT * from Subscriptions where MetadataAggregate ='{\"fdgm\":\"gdfgkm\"}'

Insert

CustomerId and ItemsAggregate columns are required to create a new subscription:

INSERT INTO Subscriptions (CustomerId, TrialEnd, ItemsAggregate,CancelAtPeriodEnd) VALUES ('cus_PDYvuww0WynoTg', '2023-12-22', '[{\"price\": \"43\",\"quantity\":\"12\"}]', true)

Alternatively, you can provide CustomerId and PlanId columns to create a new subscription:

INSERT INTO Subscriptions (CustomerId, PlanId, TrialEnd,CancelAtPeriodEnd) VALUES ('cus_LMchUD47S8Eumg', 'price_1ONAgvCZ8rn6wdu','2024-12-22', true)

Update

To update a subscription, specify the Id:

UPDATE Subscriptions SET ApplicationFeePercent = 0, MetadataAggregate='[{\"order\":\"14453\"}]' WHERE Id = 'sub_A9WZGVTbvgBJ4t'

Delete

To delete a subscription, specify the Id.

DELETE FROM Subscriptions WHERE Id = 'sub_A9WZGVTbvgBJ4t'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the subscription.
CustomerId	String	False	Customers.Id	The Id of the customer who owns the subscription.
PlanId	String	False	Plans.Id	The Id of the plan.
PlanActive	Boolean	True		Whether the plan can be used for new purchases.
PlanAggregateUsage	String	True		Specifies a usage aggregation strategy for plans of usage_type=metered.
PlanAmount	Integer	True		The unit amount in cents to be charged, represented as a whole integer if possible.
PlanAmountDecimal	String	True		The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
PlanBillingScheme	String	True		Describes how to compute the price per period.
PlanCreated	Datetime	True		Time at which the object was created. Measured in seconds since the Unix epoch.
PlanCurrency	String	True		Three-letter ISO currency code, in lowercase. Must be a supported currency.
PlanInterval	String	True		The frequency at which a subscription is billed. One of day, week, month or year.
PlanIntervalCount	Integer	True		The number of intervals (specified in the interval attribute) between subscription billings.
PlanLivemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
PlanMetadata	String	True		Set of key-value pairs that you can attach to an object.
PlanMeter	String	True		The meter tracking the usage of a metered price.
PlanNickname	String	True		A brief description of the plan, hidden from customers.
PlanObject	String	True		String representing the object's type. Objects of the same type share the same value.
PlanProduct	String	True		The product whose pricing this plan determines.
PlanTiersMode	String	True		Defines if the tiering price should be graduated or volume based.
PlanTransformUsage	String	True		Apply a transformation to the reported usage or set quantity before computing the amount billed.
PlanTrialPeriodDays	Integer	True		Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.
PlanUsageType	String	True		Configures how the quantity per period should be determined.
ApplicationFeePercent	Decimal	False		A positive decimal that represents the fee percentage of the subscription invoice amount that will be transferred to the application of the Stripe account owner each billing period.
CancelAtPeriodEnd	Boolean	False		If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
CanceledAt	Datetime	True		If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
CreatedAt	Datetime	True		The creation date.
CurrentPeriodEnd	Datetime	True		End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
CurrentPeriodStart	Datetime	True		Start of the current period that the subscription has been invoiced for.
CouponId	String	False		The id of the discount coupon.
EndedAt	Datetime	True		If the subscription has ended (either because it was canceled or because the customer was switched to a subscription to a new plan), the date the subscription ended.
Quantity	Double	True		The quantity of the plan to which the customer should be subscribed. For example, if your plan is $10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged $50 (5 x $10) monthly.
StartDate	Datetime	True		Date the most recent update to this subscription started.
Status	String	True		The status of the subscription The allowed values are active, past_due, unpaid, canceled, incomplete, incomplete_expired, trialing, all, ended, paused.
TaxPercent	Decimal	True		If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.
TrialEnd	Datetime	False		If the subscription has a trial, the end of that trial.
TrialStart	Datetime	True		If the subscription has a trial, the beginning of that trial.
MetadataAggregate	String	False		The set of key/value pairs that you can attach to a subscription object.
BillingCycleAnchor	Datetime	False		Determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices.
DefaultPaymentMethod	String	False		ID of the default payment method for the subscription
ItemsAggregate	String	False		List of subscription items, each with an attached price.
LatestInvoice	String	True		The ID of the most recent invoice this subscription has generated.
PendingSetupIntent	String	True		You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments.
PendingUpdate	String	True		If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
BillingThresholds	String	False		Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
AutomaticTaxEnabled	Boolean	False		Automatic tax settings for this subscription.
AutomaticTaxLiabilityAccount	String	False		The connected account being referenced when type is account.
AutomaticTaxLiabilityType	String	False		Type of the account referenced.
CollectionMethod	String	False		Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. The allowed values are charge_automatically, send_invoice.
DaysUntilDue	Integer	False		Number of days a customer has to pay invoices generated by this subscription. This value is null for subscriptions where collection_method=charge_automatically
DefaultSource	String	False		ID of the default payment source for the subscription.
DefaultTaxRates	String	False		The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
LiveMode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
NextPendingInvoiceItemInvoice	Datetime	True		Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval
PauseCollectionBehavior	String	False		If specified, payment collection for this subscription will be paused. The payment collection behavior for this subscription while paused. One of keep_as_draft, mark_uncollectible, or void.
PauseCollectionResumesAt	Datetime	False		If specified, payment collection for this subscription will be paused. The time after which the subscription will resume collecting payments.
PaymentSettings	String	False		Payment settings passed on to invoices created by the subscription.
PendingInvoiceItemInterval	String	False		Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval. Specifies invoicing frequency. Either day, week, month or year.
PendingInvoiceItemIntervalCount	Integer	False		Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval. The number of intervals between invoices.
Schedule	String	True		The schedule attached to the subscription
TestClock	String	True		ID of the test clock this customer belongs to.
TransferData	String	False		The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
CancelAt	Datetime	False		A date in the future at which the subscription will automatically get canceled.
Description	String	False		The subscription's description.
CancellationDetailsComment	String	False		Details about why this subscription was cancelled. Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
CancellationDetailsFeedback	String	False		Details about why this subscription was cancelled. The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
CancellationDetailsReason	String	False		Details about why this subscription was cancelled. The reason why this subscription was cancelled.
Currency	String	False		Three-letter ISO currency code, in lowercase. Must be a supported currency.
TrialSettingsEndBehaviorPaymentMethod	String	False		Settings related to subscription trials. Indicates how the subscription should change when the trial ends if the user did not provide a payment method. The allowed values are cancel, pause, create_invoice.
OnBehalfOf	String	False		The account on behalf of which to charge, for each of the subscription?s invoices.
DiscountId	String	True		The Id of the discount.
DiscountCheckoutSession	String	True		The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.
DiscountCustomer	String	True		The ID of the customer associated with this discount.
DiscountStart	Datetime	True		If the subscription has a trial, the beginning of that trial.
DiscountEnd	Datetime	True		If the subscription has a trial, the end of that trial.
DiscountInvoice	String	True		The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
DiscountInvoiceItem	String	True		The invoice line item id that the discount's coupon was applied to if it was applied directly to a invoice line item.
DiscountPromotionCode	String	True		The promotion code applied to create this discount.The promotion code applied to create this discount.
DiscountSubscription	String	True		The subscription that this coupon is applied to, if it is applied to a particular subscription.
DiscountCouponCreatedAt	Datetime	True		The creation date.
DiscountCouponCurrency	String	True		If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
DiscountCouponName	String	True		Name of the coupon displayed to customers on, for instance, invoices or receipts.
DiscountCouponDuration	String	True		One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
DiscountCouponDurationInMonths	Integer	True		the number of months the coupon applies.
DiscountCouponAmountOff	Integer	True		Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer.
DiscountCouponPercentOff	Integer	True		Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with a percent_off of 50 will make a $100 invoice $50 instead.
DiscountCouponValid	Boolean	True		Taking account of the above properties, whether this coupon can still be applied to a customer.
DiscountCouponMaxRedemptions	Integer	True		Maximum number of times this coupon can be redeemed, in total, before it is no longer valid.
DiscountCouponRedeemBy	Datetime	True		Date after which the coupon can no longer be redeemed.
DiscountCouponTimesRedeemed	Integer	True		Number of times this coupon has been applied to a customer.
DiscountCouponObject	String	True		String representing the object's type. Objects of the same type share the same value.
DiscountCouponLiveMode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
DiscountCouponMetadataAggregate	String	True		Set of key-value pairs that you can attach to an object.
Application	String	True		ID of the Connect Application that created the subscription.
BillingCycleAnchorConfigDayofMonth	Integer	False		The day of the month of the billing_cycle_anchor.
BillingCycleAnchorConfigHour	Integer	False		The hour of the day of the billing_cycle_anchor.
BillingCycleAnchorConfigminute	Integer	False		The minute of the hour of the billing_cycle_anchor.
BillingCycleAnchorConfigmonth	Integer	False		The month to start full cycle billing periods.
BillingCycleAnchorConfigsecond	Integer	False		The second of the minute of the billing_cycle_anchor.
InvoiceSettingsAccountTaxIds	String	False		Invoice settings account tax ids.
InvoiceSettingsIssuerType	String	False		Invoice settings issuer type.
InvoiceSettingsIssuerAccount	String	False		The connected account being referenced when InvoiceSettingsIssuerType is account.

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
IsProrate	Boolean	Flag indicating whether to prorate switching plans during a billing cycle.
ProrationDate	Date	If set, the proration will be calculated as though the subscription was updated at the given time. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
PaymentBehavior	String	Use allow_incomplete to transition the subscription to status=past_due if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription?s invoice.
ProrationBehavior	String	Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item?s quantity changes. The default value is create_prorations.
TrialPeriodDays	Integer	The number of trial period days before the customer is charged for the first time. If set, trial_period_days overrides the default trial period days of the plan the customer is being subscribed to. TrialPeriodDays only works for the INSERT operation.
AccountId	String	The Id of the connected account to get subscriptions for.

TaxIds

Creates, deletes and queries the Tax Ids in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id, OwnerType, OwnerAccount, OwnerCustomer and AccountId support the following operator: =.

You can select:

A tax id by specifying its Id:

SELECT * FROM TaxIds WHERE Id = 'txi_1Q3XrEATXQzBWNrlcebspJzb'

Tax ids associated with an account:

SELECT * FROM TaxIds WHERE OwnerType = 'account' AND OwnerAccount = 'acct_1B42lgHolImcIH68'

Tax ids associated with a customer:

SELECT * FROM TaxIds WHERE OwnerType = 'customer' AND OwnerCustomer = 'cus_82RUaYXb4z4XFV'

Tax ids associated with an application (Either provide the account id in the query or in the AccountId connection property):

SELECT * FROM TaxIds WHERE OwnerType = 'application' AND AccountId = 'acct_1B42lgHolImcIH68'

Tax ids associated with the current authenticated account:

SELECT * FROM TaxIds

Insert

The Type and Value columns are required to create a new tax id:

INSERT INTO TaxIds (Type, Value) VALUES ('eu_vat', 'DE131156989')

To create a tax id on a particular account use OwnerType = 'account':

INSERT INTO TaxIds (Type, Value, OwnerType, OwnerAccount) VALUES ('eu_vat', 'DE993156911', 'account', 'acct_1B42lgHolImcIH68')

To create a tax id on a particular customer use OwnerType = 'customer':

INSERT INTO TaxIds (Type, Value, OwnerType, OwnerCustomer) VALUES ('eu_vat', 'DE991911189', 'customer', 'cus_82RUaYXb4z4XFV')

To create a tax id on the connected application use OwnerType = 'application' along with AccountId:

INSERT INTO TaxIds (Type, Value, OwnerType, AccountId) VALUES ('eu_vat', 'DE999411789', 'application', 'acct_1B42lgHolImcIH68')

Delete

To delete a tax id, specify the Id:

DELETE FROM TaxIds WHERE Id = 'txi_1Q3XrEATXQzBWNrlcebspJzb'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the tax codes.
Country	String	True		Two-letter ISO code representing the country of the tax ID.
Customer	String	True		ID of the customer.
Type	String	False		Type of the tax ID, one of ad_nrt, ae_trn, ar_cuit, au_abn, au_arn, bg_uic, bh_vat, bo_tin, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_uid, ch_vat, cl_tin, cn_tin, co_nit, cr_tin, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, kz_bin, li_uid, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sv_nit, th_vat, tr_tin, tw_vat, ua_vat, us_ein, uy_ruc, ve_rif, vn_tin, or za_vat. Note that some legacy tax IDs have type unknown. The allowed values are ad_nrt, ae_trn, ar_cuit, au_abn, au_arn, bg_uic, bh_vat, bo_tin, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_uid, ch_vat, cl_tin, cn_tin, co_nit, cr_tin, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, kz_bin, li_uid, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sv_nit, th_vat, tr_tin, tw_vat, ua_vat, unknown, us_ein, uy_ruc, ve_rif, vn_tin, za_vat.
Value	String	False		Value of the tax ID.
Created	Datetime	True		Time at which the object was created. Measured in seconds since the Unix epoch.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
OwnerType	String	False		Type of owner referenced. The default value is 'self'. The allowed values are account, application, customer, self.
OwnerAccount	String	False		The account being referenced when type is account.
OwnerCustomer	String	False		The customer being referenced when type is customer.
OwnerApplication	String	True		The Connect Application being referenced when type is application.
VerificationStatus	String	True		Tax ID verification status, one of pending, verified, unverified, or unavailable.
VerificationVerifiedAddress	String	True		Tax ID Verified address.
VerificationVerifiedName	String	True		Tax ID Verified name.
Object	String	True		String representing the object’s type. Objects of the same type share the same value.

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. Required when OwnerType = 'Application'.

TaxRates

Creates, updates, and queries the tax rates that applies to Invoices, Subscriptions, and Checkout Sessions to collect tax.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following columns and operators:

Id supports the following operator: =.
Active supports the following operator: =.
Created supports the following operators: >, >=, <, <=, =.
Inclusive supports the following operator: =.
AccountId supports the following operator: =.

The rest of the filter is executed client-side within the Sync App.

You can select from the TaxRates table with the following queries:

SELECT * FROM TaxRates WHERE Id = '123124'
SELECT * FROM TaxRates WHERE Active = 'true'
SELECT * FROM TaxRates WHERE Created >= '2023-07-14T05:36:46.000-04:00'
SELECT * FROM TaxRates WHERE Inclusive = 'true'

Insert

To create a new tax rate:

INSERT INTO TaxRates (Active, Country, Description, DisplayName, Inclusive, Jurisdiction, Percentage, TaxType) values ('true', 'IN', 'GST', 'GST India.', 'false', 'IN', '18', 'sales_tax')

Update

To modify a tax rate, specify the Id:

UPDATE TaxRates SET Description='GST for Country India' WHERE Id='123124'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the tax rates
Active	Boolean	False		Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but still works for subscriptions and invoices that already have it set.
Country	String	False		A two-letter country code.
Created	Datetime	True		The time at which the object was created. Measured in seconds since the Unix epoch.
Description	String	False		An arbitrary string attached to the tax rate for your internal use only. It is not visible to your customers.
DisplayName	String	False		The display name of the tax rates as it appears to your customer on their receipt email, PDF, and the hosted invoice page.
EffectivePercentage	Double	True		The actual/effective tax rate percentage out of 100.
Inclusive	Boolean	False		Specifies if the tax rate is inclusive or exclusive.
Jurisdiction	String	False		The jurisdiction for the tax rate. You can use this label field for tax reporting purposes.
Livemode	Boolean	True		true if the object is in live mode andfalse if in test mode.
Metadata	String	False		The set of key/value pairs that you can attach to a value list object.
Percentage	Double	False		The tax rate percentage out of 100.
State	String	False		An ISO 3166-2 subdivision code, without country prefix.
TaxType	String	False		The high-level tax type, such as vat or sales_tax. The allowed values are amusement_tax, communications_tax, gst, hst, igst, jct, lease_tax, pst, qst, rst, sales_tax, service_tax, vat.
JurisdictionLevel	String	True		The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

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 to get topups for.

TestClocks

Create, delete, and query the available TestClocks in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.

You can select from the TestClocks table with the following queries:

SELECT * FROM TestClocks WHERE Name = 'TestName'
SELECT * FROM TestClocks WHERE Status = 'active'
SELECT * FROM TestClocks WHERE Created > '2024-01-01'
SELECT * FROM TestClocks WHERE DeletesAfter < '2025-01-01'
SELECT * FROM TestClocks WHERE Id = 'clock_1PYNnU2eZvKYlo2CNSmVfWJP'

Insert

To create a new TestClock, the FrozenTime column is required:

INSERT INTO TestClocks (FrozenTime, Name) VALUES ('2024-07-03', 'TestName')

Delete

To delete a TestClock, specify the Id:

DELETE FROM TestClocks WHERE Id = 'clock_1PYNnU2eZvKYlo2CNSmVfWJP'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier for the object.
Name	String	False		The custom name supplied at creation.
Status	String	True		The status of the Test Clock.
Created	Datetime	True		The time at which the object was created, measured in seconds since the Unix epoch.
DeletesAfter	Datetime	True		The time at which this clock is scheduled to auto delete.
FrozenTime	Datetime	False		The initial frozen time for this test clock.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.

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 to get coupons for.

TopUps

Creates, updates, and queries the top-up of the Stripe balance.

Table Specific Information

Select

The Sync App 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 Sync App.

Id supports the following operator: =.
Amount supports the following operator: =.
Created supports the following operators: >, >=, <, <=, =.
Status supports the following operator: =.
AccountId supports the following operator: =.

You can select from the TopUps table with the following queries:

SELECT * FROM TopUps WHERE Id = '123124'
SELECT * FROM TopUps WHERE Amount = 1500
SELECT * FROM TopUps WHERE Created >= '2023-07-14T05:36:46.000-04:00'
SELECT * FROM TopUps WHERE Status = 'succeeded'

Insert

To create a new topup, at least Amount and Currency are required:

INSERT INTO TopUps (Amount, Currency, Description) values (500, 'USD', 'This is the first topup of 5000 USD.')

Update

To modify a topup, specify the Id:

UPDATE TopUps SET Description='This is the initial topup of 500 USD.' WHERE Id='123124'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the top-ups.
Amount	Integer	False		The amount transferred.
BalanceTransaction	String	True		The Id of the balance transaction.
Created	Datetime	True		The time at which the object was created. Measured in seconds since the Unix epoch.
Currency	String	False		A three-letter ISO currency code, in lowercase.
Description	String	False		The top-up description.
ExpectedAvailabilityDate	Datetime	True		The date the funds are expected to arrive in the Stripe account for payouts.
FailureCode	String	True		An error code explaining reason for top-up failure if available.
FailureMessage	String	True		A message to the user that further explains reason for top-up failure if available.
Livemode	Boolean	True		true if the object exists in live mode and false if in test mode.
Metadata	String	False		The set of key/value pairs that you can attach to a value list object.
Source	String	True		The source details of the Stripe user.
StatementDescriptor	String	False		Extra information about a top-up.
Status	String	True		The status of the top-up is either canceled, failed, pending, reversed, or succeeded.
TransferGroup	String	False		A string that identifies this top-up as part of a group.

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
SourceId	String	The ID of a source to transfer funds from. It is a psuedo column only supported for insert.
AccountId	String	The Id of the connected account to get topups for.

TransferReversals

Create, update, and query the available reversals belonging to a specific transfer.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
Transfer supports the following operator: =.
AccountId supports the following operator: =.

To query the TransferReversals table, the Id of the transfer whose reversals are retrieved is required:

SELECT * FROM  TransferReversals WHERE Transfer = 'tr_12345678'

Insert

The Transfer column is required to insert to this table:

INSERT INTO TransferReversals (Amount, Transfer) VALUES (2000, 'tr_12345678')

Update

To update metadata or description in this table, specify both the Id and Transfer values:

UPDATE TransferReversals SET Metadata = '{"Description": "test metadata update"}' WHERE Id = 'trr_13jgn4kj' AND Transfer = 'tr_12345678'

UPDATE TransferReversals SET Description = 'Test Description' WHERE Id = 'trr_13jgn4kj' AND Transfer = 'tr_12345678'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the reversal.
Transfer [KEY]	String	False		The Id of the transfer that was reversed.
Amount	Integer	False		A positive integer in cents representing how much of this transfer to reverse.
RefundApplicationFee	Boolean	False		Boolean indicating whether the application fee should be refunded when reversing this transfer.
Currency	String	True		The currency.
Metadata	String	False		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.
Object	String	True		String representing the object's type. Objects of the same type share the same value.
BalanceTransaction	String	True		Balance transaction that describes the impact on your account balance.
DestinationPaymentRefund	String	True		Linked payment refund for the transfer reversal.
Created	Datetime	True		Time at which the object was created. Measured in seconds since the Unix epoch.
SourceRefund	String	True		ID of the refund responsible for the transfer reversal.

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
Description	String	An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the dashboard. This will be unset if you POST an empty value.
AccountId	String	The Id of the connected account to get Transfer reversals for.

Transfers

Create, update, and query the available transfers in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id, AccountId, and Destination support the following operator: =.
Created supports the following operators: <, >, >=, <, <=, =.

You can select:

A transfer by specifying its Id:

SELECT * FROM Transfers WHERE Id = 'tr_12345678'

A transfer created after a specific date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Transfers WHERE Created = '2023-07-21 19:00:27.0'

Transfers created after a specific date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Transfers WHERE Created > '12/2/2015'

Insert

Currency, Amount, and Destination are required to insert into this table. The destination is the Id of a connected Stripe account:

INSERT INTO Transfers (Amount, Currency, Destination, TransferGroup) VALUES (1000, 'USD', 'acct_19abC2DFGl5DVRzj', 'ORDER_95')

Update

To update a transfer, set a description or metadata and specify an Id in the WHERE clause:

UPDATE Transfers SET Description = 'New desc', MetadataAggregate = '{\"test\" : \"test\"}' WHERE Id = 'tr_123456788'

Delete

Delete is not supported.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the transfer.
Currency	String	False		The currency.
Amount	Integer	False		Amount (in cents) to be transferred to your bank account.
AmountReversed	Integer	True		Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
ApplicationFee	String	True		The application fee.
BalanceTransaction	String	True		Balance transaction that describes the impact of this transfer on your account balance.
Created	Datetime	True		Time that this record of the transfer was first created.
Date	Datetime	True		Date the transfer is scheduled to arrive in the bank. This doesn't factor in delays like weekends or bank holidays.
Description	String	False		Internal-only description of the transfer.
Destination	String	False		The Id of the bank account, card, or Stripe account the transfer was sent to.
DestinationPayment	String	True		If the destination is a Stripe account, this will be the Id of the payment that the destination account received for the transfer.
FailureCode	String	True		Error code explaining reason for transfer failure if available.
FailureMessage	String	True		Message to user further explaining reason for transfer failure if available.
Reversed	Boolean	True		Whether or not the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
SourceTransaction	String	False		The Id of the charge (or other transaction) that was used to fund the transfer. If null, the transfer was funded from the available balance.
SourceType	String	False		The source balance this transfer came from.
StatementDescriptor	String	True		Extra information about a transfer to be displayed on the user's bank statement.
Status	String	True		Current status of the transfer.
Type	String	True		The type of the transfer which can be card, bank_account, or stripe_account.
MetadataAggregate	String	False		The transfer metadata object.
Object	String	True		String representing the object's type. Objects of the same type share the same value.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
ReversalsAggregate	String	True		A list of reversals that have been applied to the transfer.
TransferGroup	String	False		A string that identifies this transaction as part of a group.

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 to get transfers for.

UsageRecords

Creates and retrieves the customer usage and metrics to Stripe for metered billing for subscription prices.

Table Specific Information

Select

The Sync App 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 Sync App.

Id supports the following operator: =.
SubscriptionItem supports the following operator: =.
AccountId supports the following operator: =.

To retrieve UsageRecords, a SubscriptionItem is required:

SELECT * FROM UsageRecords WHERE SubscriptionItem='si_NBswnjzMefKen7'

Insert

To create a usage record for a subscription item, you must specify at least a SubscriptionItem value:

INSERT INTO UsageRecords (SubscriptionItem, Timestamp, Quantity) values ('si_NBswnjzMefKen7', '2023-07-14T05:36:46.000-04:00', 100)

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the usage record.
Invoice	String	True		The Id of the invoice.
Livemode	Boolean	True		true if the object is in live mode andfalse if in test mode.
PeriodEnd	Datetime	True		The time of the period end.
PeriodStart	Datetime	True		The time of the period start.
SubscriptionItem	String	False		The Id of the subscription item.
Timestamp	Datetime	False		The timestamp for the usage event.
TotalUsage	Integer	True		The total usage.

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 to get value list for.
Quantity	Integer	The usage quantity for the specified date.

ValueListItems

Creates, deletes, and queries the Values list items.

Table Specific Information

Select

The Sync App 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 Sync App.

Id supports the following operator: =.
Created supports the following operators: >, >=, <, <=, =.
Value supports the following operators: =, LIKE.
ValueList supports the following operator: =.
AccountId supports the following operator: =.

You can select from the ValueListItems table with the following queries:

SELECT * FROM ValueListItems
SELECT * FROM ValueListItems WHERE Id = '123124'
SELECT * FROM ValueListItems WHERE Created >= '2023-07-14T05:36:46.000-04:00'
SELECT * FROM ValueListItems WHERE Value = 'This is the value.'
SELECT * FROM ValueListItems WHERE ValueList = 'rsl_1MGcyqSC4snQ'

Insert

To create value list items:

INSERT INTO ValueListItems (Value, ValueList) values ('This is the list item.', 'rsl_1MGcyqSC4snQ')

Delete

To delete value list items, specify the list item Id:

DELETE FROM ValueListItems WHERE Id='123124'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the value list items.
Created	Datetime	True		The time at which the object was created. Measured in seconds since the Unix epoch.
CreatedBy	String	True		The name or email address of the user who created this value list.
Livemode	Boolean	True		true if the object exists in live mode and false if in test mode.
Value	String	False		The value of the item.
ValueList	String	False		The Id of the value list.

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 to get value list for.

ValueLists

Creates, updates, deletes, and queries values in a list.

Table Specific Information

Select

The Sync App 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 Sync App.

Id supports the following operator: =.
Alias supports the following operator: =.
Created supports the following operator: >, >=, <, <=, =.
AccountId supports the following operator: =.

You can select from the ValueLists table with the following queries:

SELECT * FROM ValueLists WHERE Id = '123124'
SELECT * FROM ValueLists WHERE Alias = 'customer_email_list'
SELECT * FROM ValueLists WHERE Created >= '2023-07-14T05:36:46.000-04:00'

Insert

To create a value list:

INSERT INTO ValueLists (Alias, ItemType, Name) values ('customer_email_li', 'email', 'Customer Email List')

Update

To modify a value list, specify the list Id:

UPDATE ValueLists SET Alias ='customer_email_list' WHERE Id='123124'

Delete

To delete a value list, specify the list Id:

DELETE FROM ValueLists WHERE Id='123124'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the value list.
Alias	String	False		The name of the value list for use in rules.
Created	Datetime	True		Time at which the object was created. Measured in seconds since the Unix epoch.
CreatedBy	String	True		The name or email address of the user who created this value list.
ItemType	String	False		The type of items in the value list. Possible values are card_fingerprint, card_bin, email, ip_address, country, string, case_sensitive_string, or customer_id.
ListItemsUrl	String	True		The URL where this list can be accessed.
Livemode	Boolean	True		true if the object is in live mode andfalse if in test mode.
Name	String	False		The name of the value list.
Metadata	String	False		The set of key/value pairs that you can attach to a value list object.

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 to get value list for.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Stripe Connector for CData Sync Views


Name	Description
ApplicationFeeRefunds	Returns a list of application fees you've previously collected.
ApplicationFees	Returns a list of file links.
Authorizations	Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
AvailableBalance	Query the Available Balance in Stripe.
BalanceChangeFromActivitySummaryReport	Query the Balance change from activity summary report in Stripe.
BalanceSummaryReport	Query the Balance Summary report in Stripe.
BalanceTransactions	Query Balance History in Stripe.
Cardholders	Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
CashBalance	Get the cash balance for the customer.
CashBalanceTransactions	Query Cash Balance Transactions in Stripe.
CheckoutSessionLineItems	Returns a list of Checkout Sessions.
CountrySpecs	Query the available Country Specs in Stripe.
CreditNoteLineItems	Query the available Credit Note line items in Stripe.
CreditNoteLineItemsDiscounts	Get the available discounts from Credit Note line items in Stripe.
CreditNotePreviewLineItems	Query the available Credit Note preview line items in Stripe.
CustomerBalanceTransactions	Returns a list of transactions that updated the customers balances.
CustomerSubscriptions	Get the available subscriptions of a Customer.
EarlyFraudWarning	Query an early fraud reported by the customer.
EndingBalanceReconciliationSummaryReport	Query the Ending balance reconciliation summary report in Stripe.
EndingBalanceReconciliationSummaryReportInternal	Query the Ending balance reconciliation summary report in Stripe.
Events	Query the available events in Stripe.
FileLinks	Returns a list of file links.
Files	Retrieves a file hosted on Stripe's servers.
InvoiceDiscounts	Get the available discounts of invoices in Stripe.
InvoiceItemDiscounts	Get the available discounts from invoices items in Stripe.
InvoiceLineItemDiscounts	Get the available discounts from invoices line items in Stripe.
InvoiceLineItems	Query the available invoices line items in Stripe.
IssuingCards	Returns a list of Issuing Card objects.
IssuingDisputes	Returns a list of Issuing Dispute objects.
ItemizedBalanceChangeFromActivityReport	Query the Itemized balance change from Activity report in Stripe.
ItemizedEndingBalanceReconciliationReport	Query the Itemized ending balance change from activity report in Stripe.
ItemizedPayoutReconciliationReport	Query the Itemized payout reconciliation report in Stripe.
ItemizedPayoutsReport	Query the Itemized payouts report in Stripe.
ItemizedReconciliationForASinglePayoutReport	Query the Itemized reconciliation for a single payout report in Stripe.
PaymentLinkLineItems	Query the available PaymentLink line items in Stripe.
PaymentMethodDomains	Lists the details of existing payment method domains.
PayoutsReconciliationSummaryForASinglePayoutReport	Payouts reconciliation summary for a single payout in Stripe.
PayoutsReconciliationSummaryReport	Query the Payouts reconciliation summary report in Stripe.
PayoutsSummaryReport	Query the Payouts summary report in Stripe.
PendingBalance	Query the available balance in Stripe.
Reports	To Create and Query the Report Run object, which represents an instance of a report type generated with specific run parameters.
ReportTypes	To query the available report types.
Reviews	Queries the reviews.
SetupAttempts	Returns a list of SetupAttempts that associate with a provided SetupIntent.
SetupIntents	Returns a list of SetupIntents.
SubscriptionSchedules	Retrieves the list of your subscription schedules.
TaxCodes	Queries the tax codes which classify goods and services for tax purposes.
Transactions	Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

ApplicationFeeRefunds

Returns a list of application fees you've previously collected.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

ApplicationFeeId supports the following operator: =.
Id supports the following operator: =.

You can select from ApplicationFeeRefunds with the following queries:

    SELECT * FROM ApplicationFeeRefunds WHERE ApplicationFeeId = 'fee_1ACvR6I2xUg5aQMAnqlDqwJY'
    SELECT * FROM ApplicationFeeRefunds WHERE Id = 'fr_A2ZYOWsSreeFvP'

Columns


Name	Type	References	Description
Id [KEY]	String		The id of files.
ApplicationFeeId [KEY]	String		The Id of the application fee.
Amount	Integer		Amount, in cents.
BalanceTransaction	String		Balance transaction that describes the impact on your account balance.
Currency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
MetadataAggregate	String		The set of key/value pairs that you can attach to a an object.

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 to get files for.

ApplicationFees

Returns a list of file links.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
Charge supports the following operator: =.

You can select from ApplicationFees with the following queries:

    SELECT * from ApplicationFees where charge = 'py_1Ofr5O2cbZNns1OzqCZGhR9a'
    SELECT * FROM ApplicationFees WHERE Created > '2024-01-01'
    SELECT * FROM ApplicationFees WHERE Refunded = true
    SELECT * FROM ApplicationFees WHERE Currency = 'usd'

Columns


Name	Type	References	Description
Id [KEY]	String		The id of files.
Amount	Integer		Amount, in cents.
AmountRefunded	Integer		Amount in cents refunded (can be less than the amount attribute on the fee if a partial refund was issued).
Application	String		ID of the Connect application that earned the fee.
BalanceTransaction	String		Balance transaction that describes the impact on your account balance.
Charge	String		ID of the charge that the application fee was taken from.
Currency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
OriginatingTransaction	String		ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destination parameter.
Refunded	Boolean		Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
Refunds	String		A list of refunds that have been applied to the fee.
AccountId	String		The Id of the connected account to get files for.

Authorizations

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
CardId supports the following operator: =.
CardCardholderId supports the following operator: =.
Status supports the following operator: =.
Created supports the following operator: =.

You can select from Authorizations with the following queries:

    SELECT * from Authorizations WHERE CardId = 'ic_1Nsse72eZvKYlo2CWBGm2WQ5'
    SELECT * from Authorizations WHERE CardCardholderId = 'ich_1NpvWO2eZvKYlo2CAQ7YPOvp'
    SELECT * from Authorizations WHERE Id = 'iauth_1ObVV22eZvKYlo2C9UYAEpOT'

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
Amount	Integer		The total amount that was authorized or rejected.
AmountDetailsAtmFee	Integer		The fee charged by the ATM for the cash withdrawal.
AmountDetailsCashbackAmount	Integer		The amount of cash requested by the cardholder.
Approved	Boolean		Whether the authorization has been approved.
AuthorizationMethod	String		How the card details were provided.
BalanceTransactions	String		List of balance transactions associated with this authorization.
CardId	String		Unique identifier for the object.
CardObject	String		String representing the objects type. Objects of the same type share the same value.
CardBrand	String		The brand of the card.
CardCancellation_reason	String		The reason why the card was canceled.
CardCardholderId	String		Unique identifier for the object.
CardCardholderObject	String		String representing the objects type. Objects of the same type share the same value.
CardCardholderBillingAddressCity	String		City, district, suburb, town, or village.
CardCardholderBillingAddressCountry	String		Two-letter country code
CardCardholderBillingAddressLine1	String		Address line 1
CardCardholderBillingAddressLine2	String		Address line 2
CardCardholderBillingAddressPostalCode	String		ZIP or postal code.
CardCardholderBillingAddressState	String		State, county, province, or region.
CardCardholderCompanyTaxIdProvided	Boolean		Whether the companys business ID number was provided.
CardCardholderCreated	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
CardCardholderEmail	String		The cardholders email address.
CardIssuingUserTermsAcceptanceDate	Datetime		The Unix timestamp marking when the cardholder accepted the Authorized User Terms.
CardIssuingUserTermsAcceptanceIP	String		The IP address from which the cardholder accepted the Authorized User Terms.
CardIssuingUserTermsAcceptanceUserAgent	String		The user agent of the browser from which the cardholder accepted the Authorized User Terms.
CardCardholderDOBDay	Integer		The day of birth, between 1 and 31.
CardCardholderDOBMonth	Integer		The month of birth, between 1 and 12.
CardCardholderDOBYear	Integer		The four-digit year of birth.
CardCardholderFirstName	String		The first name of this cardholder.
CardCardholderLastName	String		The last name of this cardholder.
CardCardholderVerficationDocBack	String		The back of a document returned by a file upload with a purpose value of identity_document.
CardCardholderVerficationDocFront	String		The front of a document returned by a file upload with a purpose value of identity_document.
CardCardholderLivemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
CardCardholderMetadataAggregate	String		The set of key/value pairs that you can attach to a an object.
CardCardholderName	String		The cardholders name. This will be printed on cards issued to them.
CardCardholderPhoneNumber	String		The cardholders phone number. This is required for all cardholders who will be creating EU cards.
CardCardholderPreferredLocales	String		The cardholders preferred locales (languages), ordered by preference.
CardCardholderRequirementsDisabledReason	String		If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason.
CardCardholderRequirementsPastDue	String		Array of fields that need to be collected in order to verify and re-enable the cardholder.
CardCardholderSpendingControlsAllowedCategories	String		Array of strings containing categories of authorizations to allow.
CardCardholderSpendingControlsBlockedCategories	String		Array of strings containing categories of authorizations to decline.
CardCardholderSpendingControlsSpendingLimits	String		Limit spending with amount-based rules that apply across this cardholders cards.
CardCardholderSpendingControlsSpendingLimitsCurrency	String		Currency of the amounts within spending_limits.
CardCardholderStatus	String		Specifies whether to permit authorizations on this cardholder’s cards.
CardCardholderType	String		One of individual or company.
CardCreated	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
CardCurrency	String		Three-letter ISO currency code, in lowercase.
CardCVC	String		The cards CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter.
CardExpMonth	Integer		The expiration month of the card.
CardExpYear	Integer		The expiration year of the card.
CardLast4	String		The last 4 digits of the card number.
CardLivemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
CardMetadataAggregate	String		The set of key/value pairs that you can attach to a an object.
CardNumber	String		The full unredacted card number.
CardReplacedBy	String		The latest card that replaces this card, if any.
CardReplacementFor	String		The card this card replaces, if any.
CardReplacementReason	String		The reason why the previous card needed to be replaced.
CardShipping	String		Where and how the card will be shipped.
CardCardholderSpendingControlsAllowedMerchantCountries	String		Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control.
CardCardholderSpendingControlsBlockedMerchantCountries	String		Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control.
CardPersonalizationDesign	String		The personalization design object belonging to this card.
CardSpendingControlsAllowedCategories	String		Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with blocked_categories.
CardSpendingControlsAllowedMerchantCountries	String		Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control.
CardSpendingControlsBlockedCategories	String		Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with allowed_categories.
CardSpendingControlsBlockedMerchantCountries	String		Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control.
CardSpendingControlsSpendingLimits	String		Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its replacement_for card and that card’s replacement_for card, up the chain).
CardSpendingControlsSpendingLimitsCurrency	String		Currency of the amounts within spending_limits. Always the same as the currency of the card.
CardType	String		The type of the card. Possible enum values: physical, virtual.
CardWalletsApplePayEligible	Boolean		Apple Pay Eligibility.
CardWalletsApplePayIneligibleReason	String		Reason the card is ineligible for Apple Pay.
CardWalletsGooglePayEligible	Boolean		Google Pay Eligibility.
CardWalletsGooglePayIneligibleReason	String		Reason the card is ineligible for Google Pay.
CardWalletsPrimaryAccountIdentifier	String		Unique identifier for a card used with digital wallets.
Cardholder	String		The cardholder to whom this authorization belongs.

AvailableBalance

Query the Available Balance in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

AccountId support the following operator: =.

You can select from Authorizations with the following queries:

    SELECT * FROM AvailableBalance WHERE AccountId = 'acct_1Gqj58Ly0qyl5A'
    SELECT * FROM AvailableBalance WHERE Currency = 'usd'
    SELECT * FROM AvailableBalance WHERE Livemode = true
    SELECT * FROM AvailableBalance WHERE Amount > 10000

Columns


Name	Type	References	Description
Currency	String		The currency of the available balance.
Amount	Long		The available amount.
SourceTypesCard	Long		The source cards.
SourceTypesBankAccount	Long		Amount for bank account.
SourceTypesBitcoinReceiver	Long		Amount for Bitcoin Receiver.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.

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 to get available balance for

BalanceChangeFromActivitySummaryReport

Query the Balance change from activity summary report in Stripe.

Table Specific Information

Used to query the balance change from the activity summary report in Stripe.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Creating the Report

To create a report, the following parameters are required:

ParametersIntervalStart
ParametersIntervalEnd

You can also include the following optional parameters:

Id
ParametersColumns
ParametersCurrency

// This first creates the new Report and displays it. Report Creation takes time; once it is created it displays the report.
SELECT * FROM BalanceChangeFromActivitySummaryReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'

Select

You can run the following queries to retrieve report data:

SELECT * FROM BalanceChangeFromActivitySummaryReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'balance_change_from_activity.summary.1')
SELECT * FROM BalanceChangeFromActivitySummaryReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY')  // This shows multiple reports
SELECT * FROM BalanceChangeFromActivitySummaryReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This shows a respective report

Columns


Name	Type	References	Description
Reporting_Category	String		Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Currency	String		Three-letter ISO code for the currency in which gross, fee and net are defined.
Count	Int		The number of transactions associated with the reporting_category.
Gross	Decimal		Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee	Decimal		Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net	Decimal		Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Id [KEY]	String	Reports.Id	Unique identifier for the reports run object.
ParametersIntervalEnd	Datetime		Ending timestamp of data to be included in the report run (exclusive).
ParametersIntervalStart	Datetime		Starting timestamp of data to be included in the report run.
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersCurrency	String		Currency of objects to be included in the report run.

BalanceSummaryReport

Query the Balance Summary report in Stripe.

Table Specific Information

Used to query the Balance Summary report in Stripe.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Creating the Report

To create a report, the following parameters are required:

ParametersIntervalStart
ParametersIntervalEnd

You can also include the following optional parameters:

Id
ParametersColumns
ParametersCurrency
ParametersTimezone

//  This first creates the new Report and displays it. Report Creation takes time once it is created will display the report.
SELECT * FROM BalanceSummaryReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'

Select

You can run the following queries to retrieve report data:

SELECT * FROM BalanceSummaryReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'balance.summary.1')
SELECT * FROM BalanceSummaryReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM BalanceSummaryReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report

Columns


Name	Type	References	Description
Category	String		One of starting_balance, ending_balance, activity or payouts.
Description	String		One of Starting balance (YYYY-MM-DD) - the balance at the start of the period, Activity - the net amount of all transactions that affected your balance except for payouts, Less payouts - the amount of payouts to your bank account, or Ending balance (YYYY-MM-DD) - the balance left over at the end of the period after subtracting payouts from the Starting balance and Activity.
Net_Amount	Decimal		Net amount for the transactions associated with category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Currency	String		Three-letter ISO code for the currency in which net_amount is defined.
Id [KEY]	String	Reports.Id	Unique identifier for the reports run object.
ParametersIntervalEnd	Datetime		Ending timestamp of data to be included in the report run (exclusive).
ParametersIntervalStart	Datetime		Starting timestamp of data to be included in the report run.
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersCurrency	String		Currency of objects to be included in the report run.
ParametersTimezone	String		Defaults to Etc/UTC. The output timezone for all timestamps in the report.

BalanceTransactions

Query Balance History in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id, Currency, Source, Type, Payout, and AccountId support the following operator: =.
Created supports the following operators: >, >=, <, <=, =.

You can select from BalanceTransactions with the following queries:

    SELECT * FROM BalanceTransactions
    SELECT * FROM BalanceTransactions WHERE Id = 'txn_1K2M4c2eZvKYlo2C1C1A1bQq'
    SELECT * FROM BalanceTransactions WHERE Created >= '2023-01-01' AND Created <= '2023-12-31'
    SELECT * FROM BalanceTransactions WHERE Created >= '2023-01-01' AND Created <= '2023-12-31'

You can also filter balance transactions by a specified payout:

SELECT * FROM BalanceTransactions WHERE Payout = '123'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the balance transaction.
Amount	Integer		Gross amount of the transaction, in cents.
AvailableOn	Datetime		The date the net funds of the transaction will become available in the Stripe balance.
Created	Datetime		The datetime of creation.
Currency	String		The currency of the transaction.
Description	String		The transaction description.
Fee	Integer		Fees (in cents) paid for this transaction.
FeeDetailsAggregate	String		The fee details.
Net	Integer		Net amount of the transaction, in cents.
Source	String		The Stripe object this transaction is related to.
Status	String		If the net funds of the transaction are available in the Stripe balance yet. Either available or pending.
Type	String		Transaction type.
ReportingCategory	String		reporting categories can help you understand balance transactions from an accounting perspective.
ExchangeRate	Decimal		The exchange rate used, if applicable, for this transaction.

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
Transfer	String		For automatic Stripe transfers only, only returns transactions that were transferred out on the specified transfer Id.
Payout	String		For automatic Stripe payouts only, only returns transactions that were payed out on the specified payout ID.
AccountId	String		The Id of the connected account to get balance history for

Cardholders

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
Created supports the following operator: =.
Email supports the following operator: =.
PhoneNumber supports the following operator: =.
Status supports the following operator: =.
Type supports the following operator: =.

You can select from BalanceTransactions with the following queries:

    SELECT * FROM Cardholders WHERE Id = 'ich_1OctV22eZvKYlo2C6ETSndgk'
    SELECT * FROM Cardholders WHERE Created = '2024-01-18 02:16:47.0'
    SELECT * FROM Cardholders WHERE PhoneNumber = '+1234567890'
    SELECT * FROM Cardholders WHERE Email = '[email protected]'

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
BillingAddressCity	String		City, district, suburb, town, or village.
BillingAddressCountry	String		Two-letter country code
BillingAddressLine1	String		Address line 1
BillingAddressLine2	String		Address line 2
BillingAddressPostalCode	String		ZIP or postal code.
BillingAddressState	String		State, county, province, or region.
Email	String		The cardholders email address.
MetadataAggregate	String		The set of key/value pairs that you can attach to a an object.
Name	String		The cardholders name. This will be printed on cards issued to them.
IsCompanyTaxIdProvided	Boolean		The cardholders phone number.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
Individual	String		Additional information about an individual cardholder.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Object	String		String representing the objects type. Objects of the same type share the same value.
PhoneNumber	String		The cardholders phone number.
RequirementsDisabledReason	String		If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason.
RequirementsPastDue	String		Array of fields that need to be collected in order to verify and re-enable the cardholder.
SpendingControlsAllowedCategories	String		Array of strings containing categories of authorizations to allow.
SpendingControlsBlockedCategories	String		Array of strings containing categories of authorizations to decline.
SpendingControlsSpendingLimits	String		Limit spending with amount-based rules that apply across this cardholders cards.
SpendingControlsSpendingLimitsCurrency	String		Currency of the amounts within spending_limits.
Status	String		Specifies whether to permit authorizations on this cardholders cards.
Type	String		One of individual or company.
PreferredLocales	String		The cardholder's preferred locales (languages), ordered by preference. Locales can be de, en, es, fr, or it. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.
SpendingControlsAllowedMerchantCountries	String		Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control.
SpendingControlsBlockedMerchantCountries	String		Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control.

CashBalance

Get the cash balance for the customer.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following column and operator:

CustomerId supports the = operator.
AccountId supports the = operator.

The rest of the filter is executed client-side within the Sync App.

You can select from CashBalance with the following queries:

    SELECT * FROM CashBalance WHERE CustomerId = 'cus_qwew123'
    SELECT * FROM CashBalance WHERE Livemode = true
    SELECT * FROM CashBalance WHERE AccountId = 'acct_1Gqj58Ly0qyl5A'

Columns


Name	Type	References	Description
CustomerId [KEY]	String		The Id of the customer.
Available	String		A hash of all cash balances available to this customer.
Livemode	Boolean		true if the object is in live mode andfalse if in test mode.
object	String		String representing the object's type.
ReconciliationMode	String		The configuration for how funds that land in the customer cash balance are reconciled.
UsingMerchantDefault	Boolean		A flag to indicate if reconciliation mode returned is the user?s default or is specific to this customer cash balance.

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 to get customer discounts for

CashBalanceTransactions

Query Cash Balance Transactions in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id and CustomerId support the following operator: =.

You can select:

All cash balance transactions:

SELECT * FROM CashBalanceTransactions

A cash balance transaction by specifying both its Id and CustomerId:

SELECT * FROM CashBalanceTransactions WHERE Id = 'ccsbtxn_1Q0yb2ATXQzBWNrl8rqvEizC' AND CustomerId = 'cus_PwQLqslVNldED7'

Cash balance transactions associated with its associated CustomerId:

SELECT * FROM CashBalanceTransactions WHERE CustomerId = 'cus_PwQLqslVNldED7'

Cash balance transactions associated with its Id:

SELECT * FROM CashBalanceTransactions WHERE Id = 'ccsbtxn_1Q3XBhATXQzBWNrlqd5UcD8l'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the Cash Balance Transaction.
CustomerId [KEY]	String	Customers.Id	The customer whose available cash balance changed as a result of this transaction.
AdjustedForOverdraftBalanceTransaction	String		If this is a type=adjusted_for_overdraft transaction, contains the Balance Transaction that corresponds to funds taken out of your Stripe balance.
AdjustedForOverdraftLinkedTransaction	String		If this is a type=adjusted_for_overdraft transaction, contains the Cash Balance Transaction that brought the customer balance negative, triggering the clawback of funds.
AppliedToPaymentPaymentIntent	String		If this is a type=applied_to_payment transaction, contains the Payment Intent that funds were applied to.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
Currency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
EndingBalance	Integer		The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit.
FundedBankTransferEuBankTransferBic	String		If this is a type=funded transaction, and the bank transfer is an EU bank transfer which funded the customer's cash balance, contains the BIC of the bank of the sender of the funding.
FundedBankTransferEuBankTransferIbanLast4	Integer		If this is a type=funded transaction, and the bank transfer is an EU bank transfer which funded the customer's cash balance, contains the last 4 digits of the IBAN of the sender of the funding.
FundedBankTransferEuBankTransferSenderName	String		If this is a type=funded transaction, and the bank transfer is an EU bank transfer which funded the customer's cash balance, contains the full name of the sender, as supplied by the sending bank.
FundedBankTransferGbBankTransferAccountNumberLast4	Integer		If this is a type=funded transaction, and the bank transfer is a UK bank transfer which funded the customer's cash balance, contains the last 4 digits of the account number of the sender of the funding.
FundedBankTransferGbBankTransferSenderName	String		If this is a type=funded transaction, and the bank transfer is a UK bank transfer which funded the customer's cash balance, contains the full name of the sender, as supplied by the sending bank.
FundedBankTransferGbBankTransferSortCode	String		If this is a type=funded transaction, and the bank transfer is a UK bank transfer which funded the customer's cash balance, contains the sort code of the bank of the sender of the funding.
FundedBankTransferJpBankTransferSenderBank	String		If this is a type=funded transaction, and the bank transfer is a Japan bank transfer which funded the customer's cash balance, contains the name of the bank of the sender of the funding.
FundedBankTransferJpBankTransferSenderBranch	String		If this is a type=funded transaction, and the bank transfer is a Japan bank transfer which funded the customer's cash balance, contains the name of the bank branch of the sender of the funding.
FundedBankTransferJpBankTransferSenderName	String		If this is a type=funded transaction, and the bank transfer is a Japan bank transfer which funded the customer's cash balance, contains the full name of the sender, as supplied by the sending bank.
FundedBankTransferReference	String		If this is a type=funded transaction, contains the user-supplied reference field on the bank transfer.
FundedBankTransferType	String		If this is a type=funded transaction, contains the funding method type used to fund the customer balance. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
FundedBankTransferUsBankTransferNetwork	String		If this is a type=funded transaction, contains US-specific banking network used for this funding.
FundedBankTransferUsBankTransferSenderName	String		If this is a type=funded transaction, contains US-specific full name of the sender, as supplied by the sending bank.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
NetAmount	Integer		The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
RefundedFromPaymentRefund	String		If this is a type=refunded_from_payment transaction, contains the Refund that moved these funds into the customer’s cash balance.
TransferredToBalanceBalanceTransaction	String		If this is a type=transferred_to_balance transaction, contains the Balance Transaction that corresponds to funds transferred to your Stripe balance.
Type	String		The type of the cash balance transaction. New types may be added in future.
UnappliedFromPaymentPaymentIntent	String		If this is a type=unapplied_from_payment transaction, contains the Payment Intent that funds were unapplied from.
Object	String		String representing the object’s type. Objects of the same type share the same value.

CheckoutSessionLineItems

Returns a list of Checkout Sessions.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

CheckoutSessionId supports the following operator: =.

You can select from CheckoutSessionLineItems with the following queries:

    SELECT * FROM CheckoutSessionLineItems WHERE CheckoutSessionId = 'cs_test_c1niqxjO1iwaT5asACq3TXhErRm3T7iuPV6AEbcP5ReTfutnEloisMpGol'
    SELECT * FROM CheckoutSessionLineItems WHERE Currency = 'usd'
    SELECT * FROM CheckoutSessionLineItems WHERE AmountTotal > 5000
    SELECT * FROM CheckoutSessionLineItems WHERE PriceLiveMode = true

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the Checkout Session line item.
CheckoutSessionId	String		The Id of the Checkout Session
Object	String		String representing the objects type. Objects of the same type share the same value.
AmountDiscount	Integer		Total discount amount applied. If no discounts were applied, defaults to 0.
AmountTax	Integer		Total tax amount applied. If no tax was applied, defaults to 0.
AmountSubtotal	Integer		Total before any discounts or taxes are applied.
AmountTotal	Integer		Total after discounts and taxes.
Currency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
Description	String		An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
Discounts	String		The discounts applied to the line item.
PriceId	String		Unique identifier for the object.
PriceObject	String		String representing the object’s type. Objects of the same type share the same value.
PriceActive	Boolean		Whether the price can be used for new purchases.
PriceBillingScheme	String		Describes how to compute the price per period.
PriceCreated	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
PriceCurrency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
PriceCustomUnitAmountMaximum	Integer		The maximum unit amount the customer can specify for this item.
PriceCustomUnitAmountMinimum	Integer		The minimum unit amount the customer can specify for this item.
PriceCustomUnitAmountPreset	Integer		The starting unit amount which can be updated by the customer.
PriceLiveMode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
PriceLookupKey	String		A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
PriceMetadata	String		Set of key-value pairs that you can attach to an object.
PriceNickName	String		A brief description of the price, hidden from customers.
PriceProduct	String		The ID of the product this price is associated with.
PriceRecurringAggregateUsage	String		Specifies a usage aggregation strategy for prices of usage_type=metered.
PriceRecurringInterval	String		The frequency at which a subscription is billed.
PriceRecurringIntervalCount	Integer		The number of intervals
PriceRecurringUsageType	String		Configures how the quantity per period should be determined
PriceTaxBehaviour	String		Only required if a default tax behavior was not provided in the Stripe Tax settings.
PriceTiers	String		Each element represents a pricing tier.
PriceTiersMode	String		Defines if the tiering price should be graduated or volume based.
PriceTransformQuantityDivideBy	Integer		Divide usage by this number.
PriceTransformQuantityRound	String		After division, either round the result up or down.
PriceType	String		One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
PriceUnitAmount	Integer		The unit amount in cents to be charged, represented as a whole integer if possible.
PriceUnitAmountDecimal	String		The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
Quantity	String		The quantity of products being purchased.
Taxes	String		The taxes applied to the line item.

CountrySpecs

Query the available Country Specs in Stripe.

Table Specific Information

Country Specs can be used when an account is created.

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
AccountId supports the following operator: =.

You can select from CountrySpecs with the following queries:

    SELECT * FROM CountrySpecs WHERE Id = 'MyCountrySpecsId'
    SELECT * FROM CountrySpecs WHERE AccountId = 'acct_1Gqj58Ly0qyl5A'
    SELECT * FROM CountrySpecs WHERE DefaultCurrency = 'usd'

Columns


Name	Type	References	Description
Id [KEY]	String		The ISO Country code for this country.
SupportedBankAccountCurrenciesAggregate	String		Currencies that can be accepted in the specific country.
SupportedPaymentCurrenciesAggregate	String		Currencies that can be accepted in the specified country.
SupportedPaymentMethodsAggregate	String		Payment methods available in the specified country. You will need to enable BitCoin and ACH payments on your account for those methods to appear in this list.
VerificationFieldsAggregate	String		Lists the types of verification data needed to keep an account open. Includes 'minimum' fields, which every account must eventually provide, as well as additional fields, which are only required for some merchants.
SupportedTransferCurrenciesAggregate	String		Countries that can accept transfers from the specified country.
DefaultCurrency	String		The default currency for this country.

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 to get country specs for

CreditNoteLineItems

Query the available Credit Note line items in Stripe.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following column and operator:

CreditNoteId supports the = operator.
AccountId supports the = operator.

The rest of the filter is executed client-side within the Sync App.

You can select from CreditNoteLineItems with the following queries:

    SELECT * FROM CreditNoteLineItems WHERE CreditNoteId = 'cn_1N8iWQ2eZvKYlo2CnrPpfSnK'
    SELECT * FROM CreditNoteLineItems WHERE AccountId = 'acct_1Gqj58Ly0qyl5A'
    SELECT * FROM CreditNoteLineItems WHERE Amount > 5000
    SELECT * FROM CreditNoteLineItems WHERE Livemode = true

Columns


Name	Type	References	Description
Id [KEY]	String		ID of Credit Note LineItem.
CreditNoteId	String	CreditNotes.Id	Credit Note Id.
Amount	Integer		The integer amount in cents representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
AmountExcludingTax	Integer		The integer amount in cents representing the amount being credited for this line item, excluding all tax and discounts.
Description	String		Description of the item being credited.
DiscountAmounts	String		The amount of discount calculated per discount for this line item.
InvoiceLineItem	String		ID of the invoice line item being credited.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Quantity	Integer		The number of units of product being credited.
TaxAmounts	String		The amount of tax calculated per tax rate for this line item.
TaxRates	String		The tax rates which apply to the line item.
Type	String		The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice.
UnitAmount	Integer		The cost of each unit of product being credited.
UnitAmountDecimal	Decimal		Same as unit_amount, but contains a decimal value with at most 12 decimal places.
UnitAmountExcludingTax	Decimal		The amount in cents representing the unit amount being credited for this line item, excluding all tax and discounts.

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 to get orders for.

CreditNoteLineItemsDiscounts

Get the available discounts from Credit Note line items in Stripe.

Table Specific Information

Select

You can select from CreditNoteLineItemsDiscounts with the following queries:

    SELECT * FROM CreditNoteLineItemsDiscounts WHERE CreditNoteId = 'cn_1N8iWQ2eZvKYlo2CnrPpfSnK'
    SELECT * FROM CreditNoteLineItemsDiscounts WHERE CustomerId = 'cus_ABC123'
    SELECT * FROM CreditNoteLineItemsDiscounts WHERE CouponPercentOff > 20.0
    SELECT * FROM CreditNoteLineItemsDiscounts WHERE CouponValid = true

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the discount object.
CreditNoteId	String		The Id of the credit note.
CustomerId	String		The Id of the customer.
Start	Datetime		Date that the coupon was applied.
End	Datetime		If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.
CouponId	String		The Id of the coupon.
CouponAmountOff	Integer		Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer.
CouponCurrency	String		If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
CouponName	String		Name of the coupon displayed to customers on, for instance, invoices or receipts.
CouponCreatedAt	Datetime		The creation date.
CouponDuration	String		Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating.
CouponDurationInMonths	Integer		If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
CouponPercentOff	Decimal		Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with a percent_off of 50 will make a $100 invoice $50 instead.
CouponRedeemBy	Datetime		Date after which the coupon can no longer be redeemed.
CouponTimesRedeemed	Integer		Number of times this coupon has been applied to a customer.
CouponValid	Boolean		Taking account of the above properties, whether this coupon can still be applied to a customer.
CouponMaxRedemptions	Integer		Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
PromotionCode	String		The promotion code applied to create this discount.
Subscription	String		The subscription that this coupon is applied to, if it is applied to a particular subscription.
Amount	Integer		The amount, in cents, of the discount.

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 to get orders for.

CreditNotePreviewLineItems

Query the available Credit Note preview line items in Stripe.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following column and operator:

InvoiceId supports the = operator.
AccountId supports the = operator.

The rest of the filter is executed client-side within the Sync App.

You can select from CreditNotePreviewLineItems with the following queries:

    SELECT * FROM CreditNotePreviewLineItems where InvoiceId = 'in_1PDhVw2eZvKYlo2C6J4CKKUd'
    SELECT * FROM CreditNotePreviewLineItems WHERE AccountId = 'acct_1Gqj58Ly0qyl5A'
    SELECT * FROM CreditNotePreviewLineItems WHERE Amount > 10000
    SELECT * FROM CreditNotePreviewLineItems WHERE Currency = 'usd'

Columns


Name	Type	References	Description
Id [KEY]	String		ID of the Credit Note Preview LineItem.
InvoiceId	String	Invoices.Id	ID of the invoice.
Amount	Integer		The integer amount in cents representing the total amount of the credit note.
CreditAmount	Integer		The integer amount in cents representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
AmountShipping	Integer		Amount shipping.
Created	Datetime		Date of creation.
Currency	String		Currency name.
Customer	String		Customer Id.
CustomerBalanceTransaction	String		Customer balance transaction.
DiscountAmounts	String		Discount amounts.
EffectiveAt	Datetime		The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated Date of issue printed on the credit note PDF.
Lines	String		Line items that make up the credit note.
Livemode	Boolean		Boolean value of Livemode.
Memo	String		The credit note's memo appears on the credit note PDF.
Metadata	String		Set of key-value pairs that you can attach to an object.
Number	String		Number.
OutOfBandAmount	Integer		The integer amount in cents representing the amount that is credited outside of Stripe.
Pdf	String		Pdf url.
Reason	String		Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory.
Refund	String		ID of an existing refund to link this credit note to.
RefundAmount	Integer		The integer amount in cents representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
ShippingCost	String		When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
Status	String		Status.
Subtotal	Integer		Subtotal.
SubtotalExcludingTax	Integer		Subtotal excluding tax.
TaxAmounts	String		Tax amounts.
Total	Integer		Total.
TotalExcludingTax	Integer		Total excluding tax.
Type	String		Type.
VoidedAt	Datetime		Voided at.

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 to get orders for.

CustomerBalanceTransactions

Returns a list of transactions that updated the customers balances.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id support the following operator: =.
CustomerIdId support the following operator: =.

You can select from CustomerBalanceTransactions with the following queries:

    SELECT * from CustomerBalanceTransactions where  Id = 'cbtxn_1OduT9SC4snQ4WkOY0nOBfpk'
    SELECT * from CustomerBalanceTransactions where  CustomerId = 'cbtxn_1OduT9SC4snQ4WkOY0nOBfpk'
    SELECT * FROM CustomerBalanceTransactions WHERE Amount > 5000
    SELECT * FROM CustomerBalanceTransactions WHERE Currency = 'usd'

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
CustomerId [KEY]	String		The ID of the customer the transaction belongs to.
Amount	Integer		The amount of the transaction.
Currency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
Description	String		An arbitrary string attached to the object. Often useful for displaying to users.
EndingBalance	Integer		The customer’s balance after the transaction was applied.
Type	String		Transaction type
CreditNote	String		The ID of the credit note (if any) related to the transaction.
Invoice	String		The ID of the invoice (if any) related to the transaction.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
MetadataAggregate	String		The set of key/value pairs that you can attach to a an object.
Object	String		The object’s type. Objects of the same type share the same value.

CustomerSubscriptions

Get the available subscriptions of a Customer.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

AccountId supports the following operators: =.

You can select from CustomerSubscriptions with the following queries:

    SELECT * FROM CustomerSubscriptions WHERE CustomerId = 'cus_ABC123'
    SELECT * FROM CustomerSubscriptions WHERE AccountId = 'acct_1Gqj58Ly0qyl5A'
    SELECT * FROM CustomerSubscriptions WHERE Status = 'active'
    SELECT * FROM CustomerSubscriptions WHERE Currency = 'usd'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the Subscription object.
CustomerId	String	Customers.Id	The Id of the customer.
PlanId	String	Plans.Id	The Id of the plan.
ApplicationFeePercent	Decimal		A positive decimal that represents the fee percentage of the subscription invoice amount that will be transferred to the application of the Stripe account owner each billing period.
AutomaticTaxEnabled	Boolean		Automatic tax settings for this subscription.
BillingCycleAnchor	Datetime		Determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices.
BillingThreshold	String		Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
CanceledAt	Datetime		If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
CurrentPeriodEnd	Datetime		End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
CurrentPeriodStart	Datetime		Start of the current period that the subscription has been invoiced for.
Currency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
Description	String		The subscription's description.
DaysUntilDue	Integer		Number of days a customer has to pay invoices generated by this subscription. This value is null for subscriptions where collection_method=charge_automatically
DefaultSource	String		Id of the default payment source for the subscription.
DefaultTaxRates	String		The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
EndedAt	Datetime		If the subscription has ended (either because it was canceled or because the customer was switched to a subscription to a new plan), the date the subscription ended.
Quantity	Double		The quantity of the plan to which the customer should be subscribed. For example, if your plan is $10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged $50 (5 x $10) monthly.
Schedule	String		The schedule attached to the subscription
TestClock	String		Id of the test clock this customer belongs to.
TransferData	String		The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
MetadataAggregate	String		The set of key/value pairs that you can attach to a subscription object.
LiveMode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
LatestInvoice	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
NextPendingInvoiceItemInvoice	Datetime		Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval
PauseCollection	String		If specified, payment collection for this subscription will be paused.
PaymentSettings	String		Payment settings passed on to invoices created by the subscription.
PendingSetupIntent	String		You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments.
PendingUpdate	String		If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.

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 to get customer discounts for

EarlyFraudWarning

Query an early fraud reported by the customer.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following columns and operators:

Id supports the following operator: =.
ChargeId supports the following operator: =.
Created supports the following operators: =, >, <, >=, <=.
PaymentIntent supports the following operator: =.
AccountId supports the following operator: =.

The rest of the filter is executed client-side within the Sync App.

You can select from EarlyFraudWarning with the following queries:

    SELECT * FROM EarlyFraudWarning WHERE Id = '123321'
    SELECT * FROM EarlyFraudWarning WHERE ChargeId = 'ch_3NASvLJSsh'
    SELECT * FROM EarlyFraudWarning WHERE Created >= '2024-01-01'
    SELECT * FROM EarlyFraudWarning WHERE Livemode = true

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of fraud warning.
Actionable	Boolean		An EFW is actionable if it has not received a dispute and has not been fully refunded.
ChargeId	String		The Id of the charge.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
FraudType	String		The type of fraud labelled by the issuer. Supported values are card_never_received, fraudulent_card_application, made_with_counterfeit_card, made_with_lost_card, made_with_stolen_card, misc, and unauthorized_use_of_card.
Livemode	Boolean		true if the object is in live mode andfalse if in test mode.
PaymentIntentId	String		The Id of the Payment Intent.

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 to get fraud warning for.

EndingBalanceReconciliationSummaryReport

Query the Ending balance reconciliation summary report in Stripe.

Table Specific Information

Used to query the Ending Balance Reconciliation Summary report in Stripe.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Creating the Report

To create a report, the following parameters are required:

ParametersIntervalEnd

You can also include the following optional parameters:

Id
ParametersColumns
ParametersCurrency

//  This first creates the new Report and displays it. Report Creation takes time once it is created will display the report.
SELECT * FROM EndingBalanceReconciliationSummaryReport WHERE ParametersIntervalEnd = '2020-12-28'

Select

You can run the following queries to retrieve report data:

SELECT * FROM EndingBalanceReconciliationSummaryReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'ending_balance_reconciliation.summary.1')
SELECT * FROM EndingBalanceReconciliationSummaryReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM EndingBalanceReconciliationSummaryReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report

Columns


Name	Type	References	Description
Reporting_Category	String		Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Currency	String		Three-letter ISO code for the currency in which gross, fee and net are defined.
Count	Int		The number of transactions associated with the reporting_category.
Gross	Decimal		Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee	Decimal		Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net	Decimal		Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Id [KEY]	String	Reports.Id	Unique identifier for the reports run object.
ParametersIntervalEnd	Datetime		Ending timestamp of data to be included in the report run (exclusive).
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersCurrency	String		Currency of objects to be included in the report run.

EndingBalanceReconciliationSummaryReportInternal

Query the Ending balance reconciliation summary report in Stripe.

Columns


Name	Type	References	Description
Reporting_Category	String		Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Currency	String		Three-letter ISO code for the currency in which gross, fee and net are defined.
Count	Int		The number of transactions associated with the reporting_category.
Gross	Decimal		Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee	Decimal		Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net	Decimal		Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Id [KEY]	String	Reports.Id	Unique identifier for the reports run object.
ParametersIntervalEnd	Datetime		Ending timestamp of data to be included in the report run (exclusive).
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersCurrency	String		Currency of objects to be included in the report run.

Events

Query the available events in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id, Type and AccountId support the following operator: =.
Created supports the following operators: <, >, >=, <, <=, =.

You can select:

An event by specifying its Id:

SELECT * FROM Events WHERE Id = 'dp_12345678'

Events that happened after a specific date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Events WHERE Created > '2016-01-03'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the event.
ApiVersion	String		The Stripe API version used to render data.
Created	Datetime		The datetime event was created.
ObjectId	String		The event Id.
ObjectName	String		The object name for which event occured.
Livemode	Boolean		Tells if the event is in livemode.
PendingWebhooks	Integer		The number of webhooks yet to be delivered successfully (return a 20x response) to the URLs you've specified.
RequestId	String		The Id of the API request that caused the event.
RequestIdempotencyKey	String		The idempotency key transmitted during the request, if any. Note: This property is populated only for events on or after May 23, 2017.
Type	String		The description of the event.
Description	String		An arbitrary string attached to the object. Often useful for displaying to users.The description field on invoice line items has a maximum character length limit of 500
PreviousAttributes	String		Object containing the names of the attributes that have changed.
DataObject	String		Object containing the API resource relevant to the event.
DataObjectAmount	Integer		Data object amount.
DataObjectAmountCapturable	Integer		Data object capturable amount.
DataObjectAmountDetails	String		Data object amount details.
DataObjectAmountReceived	Integer		Data object received amount.
DataObjectApplication	String		Data object application.
DataObjectApplicationFeeAmount	String		Data object application fee amount.
DataObjectAutomaticPaymentMethods	String		Data object automatic payment methods.
DataObjectCanceledAt	Datetime		Canceled At.
DataObjectCancellationReason	String		Cancellation reason.
DataObjectCaptureMethod	String		Capture Method.
DataObjectClientSecret	String		Client secret.
DataObjectConfirmationMethod	String		Confirmation method.
DataObjectCreated	Datetime		Created timestamp.
DataObjectCurrency	String		Currency code.
DataObjectCustomer	String		Customer Id.
DataObjectDescription	String		Description.
DataObjectInvoice	String		Invoice Id of the data object.
DataObjectLastPaymentError	String		Last payment error.
DataObjectLatestCharge	String		Latest charge.
DataObjectLivemode	Boolean		Boolean value of livemode.
DataObjectMetadata	String		Metadata.
DataObjectNextAction	String		Next action details.
DataObjectOnBehalfOf	String		On behalf of.
DataObjectPaymentMethod	String		Payment method.
DataObjectPaymentMethodConfigurationDetails	String		Payment method configuration details.
DataObjectPaymentMethodOptions	String		Payment method options.
DataObjectPaymentMethodTypes	String		Payment method types.
DataObjectProcessing	String		Processing.
DataObjectReceiptEmail	String		Receipt email.
DataObjectReview	String		Review.
DataObjectSetupFutureUsage	String		Setup future usage.
DataObjectShipping	String		Shipping details.
DataObjectSource	String		Source.
DataObjectStatementDescriptor	String		Statement descriptor.
DataObjectStatementDescriptorSuffix	String		Statement descriptor suffix.
DataObjectStatus	String		Status.
DataObjectTransferData	String		Transfer data.
DataObjectTransferGroup	String		Transfer group.

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 to get events for.

FileLinks

Returns a list of file links.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
File supports the following operator: =.
Expired supports the following operator: =.
Created supports the following operators: <, <=, =, >, >=.

You can select from FileLinks with the following queries:

    SELECT * FROM FileLinks WHERE Id = 'filelink_1JY7zL2eZv'
    SELECT * FROM FileLinks WHERE File = 'file_1JY7zL2eZv'
    SELECT * FROM FileLinks WHERE Expired = false 
    SELECT * FROM FileLinks WHERE Livemode = true

Columns


Name	Type	References	Description
Id [KEY]	String		The id of files.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
ExpiresAt	Datetime		The time at which the file expires and is no longer available in epoch seconds.
Expired	Boolean		Returns true if the link is already expired.
File	String		The file object this link points to.
MetadataAggregate	String		The set of key/value pairs that you can attach to a an object.
Url	String		The URL from which the file can be downloaded using your live secret API key.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.

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 to get files for.

Files

Retrieves a file hosted on Stripe's servers.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following columns and operators:

Id supports the following operator: =.
Purpose supports the following operator: =.
Created supports the following operators: >, >=, <, <=, =.
AccountId supports the following operator: =.

The rest of the filter is executed client-side within the Sync App.

You can select from Files with the following queries:

    SELECT * FROM Files WHERE Id = '123321'
    SELECT * FROM Files WHERE Purpose = 'dispute_evidence'
    SELECT * FROM Files WHERE Created >= '2023-07-14T05:36:46.000-04:00'

Columns


Name	Type	References	Description
Id [KEY]	String		The id of files.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
ExpiresAt	Datetime		The time at which the file expires and is no longer available in epoch seconds.
Filename	String		A filename for the file, suitable for saving to a filesystem.
Links	String		A list of file links that point at this file.
Purpose	String		The purpose of the uploaded file.
Size	Integer		The size in bytes of the file object.
Title	String		A user friendly title for the document.
Type	String		The type of the file returned (e.g., csv, pdf, jpg, or png).
Url	String		The URL from which the file can be downloaded using your live secret API key.

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 to get files for.

InvoiceDiscounts

Get the available discounts of invoices in Stripe.

Table Specific Information

Select

You can select from InvoiceDiscounts with the following queries:

    SELECT * FROM InvoiceDiscounts WHERE Id = 'discount_1GhPzLJXTn'
    SELECT * FROM InvoiceDiscounts WHERE Customer = 'cus_ABC123'
    SELECT * FROM InvoiceDiscounts WHERE CouponPercentOff > 20.0
    SELECT * FROM InvoiceDiscounts WHERE CouponValid = true
    SELECT * FROM InvoiceDiscounts WHERE Start >= '2024-01-01'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the discount object.
InvoiceId	String	Invoices.Id	The Id of the Invoice, which the discount is attached to.
Customer	String		The Id of the Customer.
Start	Datetime		Date that the coupon was applied.
End	Datetime		If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.
Coupon	String		The Id of the coupon.
CouponAmountOff	Integer		Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer.
CouponCurrency	String		If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
CouponName	String		Name of the coupon displayed to customers on, for instance, invoices or receipts.
CouponCreatedAt	Datetime		The creation date.
CouponDuration	String		Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating.
CouponDurationInMonths	Integer		If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
CouponPercentOff	Decimal		Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with a percent_off of 50 will make a $100 invoice $50 instead.
CouponRedeemBy	Datetime		Date after which the coupon can no longer be redeemed.
CouponTimesRedeemed	Integer		Number of times this coupon has been applied to a customer.
CouponValid	Boolean		Taking account of the above properties, whether this coupon can still be applied to a customer.
CouponMaxRedemptions	Integer		Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
PromotionCode	String		The promotion code applied to create this discount.
Subscription	String		The subscription that this coupon is applied to, if it is applied to a particular subscription.

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 to get invoices for

InvoiceItemDiscounts

Get the available discounts from invoices items in Stripe.

Table Specific Information

Select

You can select from InvoiceItemDiscounts with the following queries:

    SELECT * FROM InvoiceItemDiscounts WHERE Id = 'discount_1GhPzLJXTn'
    SELECT * FROM InvoiceItemDiscounts WHERE Customer = 'cus_ABC123'
    SELECT * FROM InvoiceItemDiscounts WHERE CouponPercentOff > 20.0
    SELECT * FROM InvoiceItemDiscounts WHERE CouponValid = true
    SELECT * FROM InvoiceItemDiscounts WHERE Start >= '2024-01-01'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the discount object.
InvoiceItemId	String	InvoiceItems.Id	The Id of the Invoice item, which the discount is attached to.
Customer	String		The Id of the Customer.
Start	Datetime		Date that the coupon was applied.
End	Datetime		If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.
Coupon	String		The Id of the coupon.
CouponAmountOff	Integer		Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer.
CouponCurrency	String		If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
CouponName	String		Name of the coupon displayed to customers on, for instance, invoices or receipts.
CouponCreatedAt	Datetime		The creation date.
CouponDuration	String		Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating.
CouponDurationInMonths	Integer		If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
CouponPercentOff	Decimal		Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with a percent_off of 50 will make a $100 invoice $50 instead.
CouponRedeemBy	Datetime		Date after which the coupon can no longer be redeemed.
CouponTimesRedeemed	Integer		Number of times this coupon has been applied to a customer.
CouponValid	Boolean		Taking account of the above properties, whether this coupon can still be applied to a customer.
CouponMaxRedemptions	Integer		Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
PromotionCode	String		The promotion code applied to create this discount.
Subscription	String		The subscription that this coupon is applied to, if it is applied to a particular subscription.

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 to get invoices for.

InvoiceLineItemDiscounts

Get the available discounts from invoices line items in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

InvoiceId supports the following operator: =.
AccountId supports the following operator: =.

You can select from InvoiceLineItemDiscounts with the following queries:

    SELECT * FROM InvoiceLineItemDiscounts WHERE Id = 'discount_1GhPzLJXTn'
    SELECT * FROM InvoiceLineItemDiscounts WHERE CustomerId = 'cus_ABC123'
    SELECT * FROM InvoiceLineItemDiscounts WHERE CouponPercentOff > 20.0
    SELECT * FROM InvoiceLineItemDiscounts WHERE CouponValid = true
    SELECT * FROM InvoiceLineItemDiscounts WHERE Start >= '2024-01-01'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the discount object.
InvoiceId	String		The Id of the invoice.
CustomerId	String		The Id of the customer.
Start	Datetime		Date that the coupon was applied.
End	Datetime		If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.
CouponId	String		The Id of the coupon.
CouponAmountOff	Integer		Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer.
CouponCurrency	String		If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
CouponName	String		Name of the coupon displayed to customers on, for instance, invoices or receipts.
CouponCreatedAt	Datetime		The creation date.
CouponDuration	String		Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating.
CouponDurationInMonths	Integer		If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
CouponPercentOff	Decimal		Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with a percent_off of 50 will make a $100 invoice $50 instead.
CouponRedeemBy	Datetime		Date after which the coupon can no longer be redeemed.
CouponTimesRedeemed	Integer		Number of times this coupon has been applied to a customer.
CouponValid	Boolean		Taking account of the above properties, whether this coupon can still be applied to a customer.
CouponMaxRedemptions	Integer		Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
PromotionCode	String		The promotion code applied to create this discount.
Subscription	String		The subscription that this coupon is applied to, if it is applied to a particular subscription.

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 to get invoices for.

InvoiceLineItems

Query the available invoices line items in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

InvoiceId support the following operator: =.
AccountId support the following operator: =.

You can select from InvoiceLineItems with the following queries:

    SELECT * FROM InvoiceLineItems WHERE Id = 'lineitem_1GhPzLJXTn'
    SELECT * FROM InvoiceLineItems WHERE InvoiceId = 'in_123456'
    SELECT * FROM InvoiceLineItems WHERE AccountId = 'acct_1Gqj58Ly0qyl5A'
    SELECT * FROM InvoiceLineItems WHERE Amount > 10000
    SELECT * FROM InvoiceLineItems WHERE Currency = 'usd'

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
InvoiceId	String		The Id of the invoice.
Amount	Integer		The amount, in cents.
AmountExcludingTax	Integer		The integer amount in cents representing the amount for this line item, excluding all tax and discounts.
Currency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
Description	String		An arbitrary string attached to the object. Often useful for displaying to users.
Discountable	Boolean		If true, discounts will apply to this line item. Always false for prorations.
InvoiceItem	String		The Id of the invoice item associated with this line item if any.
LiveMode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Metadata	String		The metadata object.
Object	String		String representing the object's type. Objects of the same type share the same value.
PeriodEnd	Datetime		The end of the period, which must be greater than or equal to the start.
PeriodStart	Datetime		The start of the period.
PriceId	String		Unique identifier for the price.
PriceObject	String		String representing the object's type. Objects of the same type share the same value.
PriceActive	Boolean		Whether the price can be used for new purchases.
PriceBillingScheme	String		Describes how to compute the price per period.
PriceCreated	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
PriceCurrency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
PriceCustomUnitAmount	String		When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
PriceLiveMode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
PriceLookupKey	String		A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
PriceMetadata	String		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.
PriceNickname	String		A brief description of the price, hidden from customers.
PriceProduct	String		The Id of the product this price is associated with.
PriceRecurring	String		The recurring components of a price such as interval and usage_type.
PriceTaxBehavior	String		Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
PriceTiersMode	String		Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
PriceTransformQuantity	String		Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
PriceType	String		One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
PriceUnitAmount	Integer		The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
PriceUnitAmountDecimal	Float		The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
Proration	Boolean		Whether this is a proration.
ProrationDetails	String		Additional details for proration line items.
Quantity	Integer		The quantity of the subscription, if the line item is a subscription or a proration.
Subscription	String		The subscription that the invoice item pertains to, if any.
SubscriptionItems	String		The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription.
Type	String		A string identifying the type of the source of this line item, either an invoiceitem or a subscription.
UnitAmountExcludingTax	String		The amount in cents representing the unit amount for this line item, excluding all tax and discounts.
DiscountAmountsAggregate	String		The amount of discount calculated per discount for this line item.
TaxAmountsAggregate	String		The amount of tax calculated per tax rate for this line item.
TaxRatesAggregate	String		The tax rates which apply to the line item.
DiscountsAggregate	String		The discounts which apply to the invoice item.
PlanActive	Boolean		Active.
PlanAggregateUsage	String		Aggregate Usage.
PlanAmount	Integer		Amount.
PlanAmountDecimal	String		Amount in decimal.
PlanBillingScheme	String		Billing scheme.
PlanCreated	Datetime		Created timestamp.
PlanCurrency	String		Currency code.
PlanId	String		Id of the plan.
PlanInterval	String		Interval.
PlanIntervalCount	Integer		Interval count.
PlanLivemode	Boolean		Livemode.
PlanMetadata	String		Metadata of the Plan.
PlanMeter	String		Meter.
PlanNickname	String		Nickname.
PlanObject	String		Object.
PlanProduct	String		Product.
PlanTiersMode	String		Tiers mode.
PlanTransformUsage	String		Transform usage.
PlanTrialPeriodDays	Integer		Trial period days.
PlanUsageType	String		Usage type.

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 to get invoice line items for.

IssuingCards

Returns a list of Issuing Card objects.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
Cardholder supports the following operator: =.
Type supports the following operator: =.
Created supports the following operator: =.
ExpMonth supports the following operator: =.
ExpYear supports the following operator: =.
Last4 supports the following operator: =.
Status supports the following operator: =.

You can select from IssuingCards with the following queries:

    SELECT * FROM IssuingCards WHERE Id = 'ic_1Mwg8K2eZvKYlo2C90clp5gj'
    SELECT * FROM IssuingCards WHERE Cardholder = 'cardholder_12345'
    SELECT * FROM IssuingCards WHERE Last4 = '0921'
    SELECT * FROM IssuingCards WHERE ExpMonth = 12
    SELECT * FROM IssuingCards WHERE ExpYear = 2025

Columns


Name	Type	References	Description
Id [KEY]	String		The id of files.
CancellationReason	String		The reason why the card was canceled.
Currency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
CardholderId	String		Unique identifier for the object.
CardholderObject	String		String representing the objects type. Objects of the same type share the same value.
CardholderBillingAddress	String		The cardholders billing address.
CardholderIsCompanyTaxIdProvided	Boolean		Whether the companys business ID number was provided.
CardholderCreated	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
CardholderEmail	String		The cardholders email address.
CardholderIndividual	String		Additional information about an individual cardholder.
CardholderName	String		The cardholders name. This will be printed on cards issued to them.
CardholderPhoneNumber	String		The cardholders phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.
CardholderPreferredLocales	String		The cardholders preferred locales (languages), ordered by preference.
CardholderRequirementsDisabledReason	String		If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason.
CardholderRequirementsPastDue	String		Array of fields that need to be collected in order to verify and re-enable the cardholder.
CardholderSpendingControlsAllowedCategories	String		Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with blocked_categories.
CardholderSpendingControlsBlockedCategories	String		Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with allowed_categories.
CardholderSpendingControlsSpendingLimits	String		Limit spending with amount-based rules that apply across this cardholders cards.
CardholderSpendingControlsSpendingLimitsCurrency	String		Currency of the amounts within spending_limits.
CardholderStatus	String		Specifies whether to permit authorizations on this cardholders cards.
CardholderType	String		One of individual or company. See Choose a cardholder type for more details.
ExpMonth	Integer		The expiration month of the card.
ExpYear	Integer		The expiration year of the card.
Last4	String		The last 4 digits of the card number.
MetadataAggregate	String		The set of key/value pairs that you can attach to a an object.
Status	String		Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to inactive.
Type	String		The type of the card.
Object	String		String representing the objects type. Objects of the same type share the same value.
Brand	String		The brand of the card.
CVC	String		The cards CVC. For security reasons, this is only available for virtual cards.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Number	String		The full unredacted card number.
ReplacedBy	String		The latest card that replaces this card, if any.
ReplacementFor	String		The card this card replaces, if any.
ReplacementReason	String		The reason why the previous card needed to be replaced.
ShippingAddress	String		Shipping address.
ShippingCarrier	String		The delivery company that shipped a card.
ShippingCustoms	String		Additional information that may be required for clearing customs.
ShippingETA	String		A unix timestamp representing a best estimate of when the card will be delivered.
ShippingName	String		Recipient name.
ShippingPhoneNumber	String		The phone number of the receiver of the shipment
ShippingRequireSignature	Boolean		Whether a signature is required for card delivery.
ShippingService	String		Shipment service, such as standard or express.
ShippingStatus	String		The delivery status of the card.
ShippingTrackingNumber	String		A tracking number for a card shipment.
ShippingTrackingURL	String		A link to the shipping carriers site where you can view detailed information about a card shipment.
ShippingType	String		Packaging options.
SpendingControlsAllowedCategories	String
SpendingControlsBlockedCategories	String
SpendingControlsSpendingLimits	String
SpendingControlsSpendingLimitsCurrency	String
WalletsApplePay	String
WalletsGooglePay	String
WalletsPrimaryAccountIdentifier	String
CardholderSpendingControlsAllowedMerchantCountries	String		Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control.
CardholderSpendingControlsBlockedMerchantCountries	String		Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control.
SpendingControlsAllowedMerchantCountries	String		Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control.
SpendingControlsBlockedMerchantCountries	String		Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control.
PersonalizationDesign	String		The personalization design object belonging to this card.

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 to get files for.

IssuingDisputes

Returns a list of Issuing Dispute objects.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
Created supports the following operator: =.
Transaction supports the following operator: =.
Status supports the following operator: =.

You can select from IssuingDisputes with the following queries:

    SELECT * FROM IssuingDisputes WHERE Id = 'id_1GhPzLJXTn'
    SELECT * FROM IssuingDisputes WHERE Created >= '2024-01-01'
    SELECT * FROM IssuingDisputes WHERE Transaction = 'txn_12345'
    SELECT * FROM IssuingDisputes WHERE Status = 'expired'
    SELECT * FROM IssuingDisputes WHERE Currency = 'usd'

Columns


Name	Type	References	Description
Id [KEY]	String		The id of files.
Amount	Integer		Disputed amount in the cards currency and in the smallest currency unit. Usually the amount of the transaction.
BalanceTransactions	String		List of balance transactions associated with the dispute.
Currency	String		The currency the transaction was made in.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
EvidenceCanceled	String		Evidence provided when reason is canceled.
EvidenceDuplicate	String		Evidence provided when reason is duplicate.
EvidenceFraudulent	String		Evidence provided when reason is fraudulent.
EvidenceMerchandiseNotAsDescribed	String		Evidence provided when reason is merchandise_not_as_described.
EvidenceNotReceived	String		Evidence provided when reason is not_received.
EvidenceOther	String		Evidence provided when reason is other.
EvidenceReason	String		The reason for filing the dispute. Its value will match the field containing the evidence.
EvidenceServiceNotAsDescribed	String		The service was not as described.
MetadataAggregate	String		The set of key/value pairs that you can attach to a an object.
Status	String		Current status of the dispute.
Transaction	String		The transaction being disputed.
Object	String		Object.
Livemode	Boolean		LiveMode.

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		Account Id.

ItemizedBalanceChangeFromActivityReport

Query the Itemized balance change from Activity report in Stripe.

Table Specific Information

Used to query the itemized balance change from the Activity report in Stripe.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Creating the Report

To create a report, the following parameters are required:

ParametersIntervalStart
ParametersIntervalEnd

You can also include the following optional parameters:

ParametersColumns
ParametersCurrency
ParametersTimezone
ParametersReportingCategory

//  This first creates the new Report and displays it. Report Creation takes time once it is created will display the report.
SELECT * FROM ItemizedBalanceChangeFromActivityReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'

Select

You can run the following queries to retrieve report data:

SELECT * FROM ItemizedBalanceChangeFromActivityReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'balance_change_from_activity.itemized.3')
SELECT * FROM ItemizedBalanceChangeFromActivityReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM ItemizedBalanceChangeFromActivityReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report

Columns


Name	Type	References	Description
Automatic_Payout_Id	String		ID of the automatically created payout associated with this balance transaction (only set if your account is on an automatic payout schedule).
Automatic_Payout_Effective_At	Datetime		The date we expect this automatic payout to arrive in your bank account, in the requested timezone, or UTC if not provided. This is also when the paid-out funds are deducted from your Stripe balance.
Balance_Transaction_Id	String		Unique identifier for the balance transaction.
Created_UTC	Datetime		Time at which the balance transaction was created. Dates in UTC.
Created	Datetime		Time at which the balance transaction was created. Dates in the requested timezone, or UTC if not provided.
Available_On_UTC	Datetime		The date the balance transactions net funds will become available in the Stripe balance. Dates in UTC.
Available_On	Datetime		The date the balance transactions net funds will become available in the Stripe balance. Dates in the requested timezone, or UTC if not provided.
Currency	String		Three-letter ISO code for the currency in which gross, fee and net are defined.
Gross	Decimal		Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee	Decimal		Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net	Decimal		Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Reporting_Category	String		Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Source_Id	String		The Stripe object to which this transaction is related.
Description	String		An arbitrary string attached to the balance transaction. Often useful for displaying to users.
Customer_Facing_Amount	Decimal		For transactions associated with charges or refunds, the amount of the original charge or refund.
Customer_Facing_Currency	String		For transactions associated with charges or refunds, the three-letter ISO code for the currency for customer_facing_amount.
Automatic_Payout_Effective_At_UTC	Datetime		The date we expect this automatic payout to arrive in your bank account, in UTC. This is also when the paid-out funds are deducted from your Stripe balance.
Customer_Id	String		The unique ID of the related customer, if any.
Customer_Email	String		Email address of the customer, if any, associated with this balance transaction.
Customer_Name	String		Name of the customer, if any, associated with this balance transaction.
Customer_Description	String		Description provided when creating the customer, often used to store the customer name.
Shipping_Address_Line1	String		First line of the shipping address associated with this charge, if any
Shipping_Address_Line2	String		Second line of the shipping address associated with this charge, if any
Shipping_Address_City	String		City of the shipping address associated with this charge, if any
Shipping_Address_State	String		State of the shipping address associated with this charge, if any
Shipping_Address_Postal_Code	String		Postal code of the shipping address associated with this charge, if any
Shipping_Address_Country	String		Country of the shipping address associated with this charge, if any
Charge_Id	String		Unique identifier for the original charge associated with this balance transaction. Available for charges, refunds and disputes.
Payment_Intent_Id	String		The unique ID of the related Payment Intent, if any.
Charge_Created_UTC	Datetime		Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in UTC.
Charge_Created	Datetime		Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in the requested timezone, or UTC if not provided.
Invoice_Id	String		Unique ID for the invoice associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing invoice.
Subscription_Id	String		Unique ID for the subscription associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing subscription.
Payment_Method_Type	String		The type of payment method used in the related payment.
Card_Brand	String		Card brand, if applicable.
Card_Funding	String		Card funding type, if applicable.
Card_Country	String		Two-letter ISO code representing the country of the card.
Statement_Descriptor	String		The dynamic statement descriptor or suffix specified when the related charge was created.
Dispute_Reason	String		Reason given by cardholder for dispute.
Connected_Account_Id	String		For Stripe Connect activity related to a connected account, the unique ID for the account.
Connected_Account_Name	String		For Stripe Connect activity related to a connected account, the name of the account.
Connected_Account_Country	String		For Stripe Connect activity related to a connected account, the two-letter ISO code representing the country of the account.
Regulatory_Tag	String		??An identifier reflecting the classification of this transaction according to local regulations, if applicable. Accounts with automatic payouts enabled receive a separate payout for each regulatory tag. ??This column is only populated for Brazilian accounts.
Payment_Metadata	String		Metadata associated with the related PaymentIntent, if any. If no PaymentIntent metadata exists, metadata from any related charge object will be returned. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys.
Refund_Metadata	String		Metadata associated with the related refund object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys.
Transfer_Metadata	String		Metadata associated with the related transfer object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys.
Id [KEY]	String	Reports.Id	Unique identifier for the reports run object.
ParametersIntervalEnd	Datetime		Ending timestamp of data to be included in the report run (exclusive).
ParametersIntervalStart	Datetime		Starting timestamp of data to be included in the report run.
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersCurrency	String		Currency of objects to be included in the report run.
ParametersReportingCategory	String		Category of balance transactions to be included in the report run.
ParametersTimezone	String		Defaults to Etc/UTC. The output timezone for all timestamps in the report.

ItemizedEndingBalanceReconciliationReport

Query the Itemized ending balance change from activity report in Stripe.

Table Specific Information

Used to query the itemized ending balance change from the Activity report in Stripe.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Creating the Report

To create a report, the following parameters are required:

ParametersIntervalEnd

You can also include the following optional parameters:

ParametersColumns
ParametersCurrency
ParametersTimezone
ParametersReportingCategory

//  This first creates the new Report and displays it. Report Creation takes time once it is created will display the report.
SELECT * FROM ItemizedEndingBalanceReconciliationReport WHERE ParametersIntervalEnd = '2020-12-28'

Select

You can run the following queries to retrieve report data:

SELECT * FROM ItemizedEndingBalanceReconciliationReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'ending_balance_reconciliation.itemized.4')
SELECT * FROM ItemizedEndingBalanceReconciliationReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY')// This will show multiple reports
SELECT * FROM ItemizedEndingBalanceReconciliationReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report

Columns


Name	Type	References	Description
Balance_Transaction_Id	String		Unique identifier for the balance transaction.
Created_UTC	Datetime		Time at which the balance transaction was created. Dates in UTC.
Created	Datetime		Time at which the balance transaction was created. Dates in the requested timezone, or UTC if not provided.
Available_On_UTC	Datetime		The date the balance transactions net funds will become available in the Stripe balance. Dates in UTC.
Available_On	Datetime		The date the balance transactions net funds will become available in the Stripe balance. Dates in the requested timezone, or UTC if not provided.
Currency	String		Three-letter ISO code for the currency in which gross, fee and net are defined.
Gross	Decimal		Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee	Decimal		Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net	Decimal		Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Reporting_Category	String		Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Source_Id	String		The Stripe object to which this transaction is related.
Description	String		An arbitrary string attached to the balance transaction. Often useful for displaying to users.
Customer_Facing_Amount	Decimal		For transactions associated with charges or refunds, the amount of the original charge or refund.
Customer_Facing_Currency	String		For transactions associated with charges or refunds, the three-letter ISO code for the currency for customer_facing_amount.
Automatic_Payout_Id	String		ID of the automatically created payout associated with this balance transaction (only set if your account is on an automatic payout schedule).
Automatic_Payout_Effective_At_UTC	Datetime		The date we expect this automatic payout to arrive in your bank account, in UTC. This is also when the paid-out funds are deducted from your Stripe balance.
Automatic_Payout_Effective_At	Datetime		The date we expect this automatic payout to arrive in your bank account, in the requested timezone, or UTC if not provided. This is also when the paid-out funds are deducted from your Stripe balance.
Customer_Id	String		The unique ID of the related customer, if any.
Customer_Email	String		Email address of the customer, if any, associated with this balance transaction.
Customer_Name	String		Name of the customer, if any, associated with this balance transaction.
Customer_Description	String		Description provided when creating the customer, often used to store the customer name.
Shipping_Address_Line1	String		First line of the shipping address associated with this charge, if any
Shipping_Address_Line2	String		Second line of the shipping address associated with this charge, if any
Shipping_Address_City	String		City of the shipping address associated with this charge, if any
Shipping_Address_State	String		State of the shipping address associated with this charge, if any
Shipping_Address_Postal_Code	String		Postal code of the shipping address associated with this charge, if any
Shipping_Address_Country	String		Country of the shipping address associated with this charge, if any
Charge_Id	String		Unique identifier for the original charge associated with this balance transaction. Available for charges, refunds and disputes.
Payment_Intent_Id	String		The unique ID of the related Payment Intent, if any.
Charge_Created_UTC	Datetime		Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in UTC.
Charge_Created	Datetime		Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in the requested timezone, or UTC if not provided.
Invoice_Id	String		Unique ID for the invoice associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing invoice.
Subscription_Id	String		Unique ID for the subscription associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing subscription.
Payment_Method_Type	String		The type of payment method used in the related payment.
Card_Brand	String		Card brand, if applicable.
Card_Funding	String		Card funding type, if applicable.
Card_Country	String		Two-letter ISO code representing the country of the card.
Statement_Descriptor	String		The dynamic statement descriptor or suffix specified when the related charge was created.
Dispute_Reason	String		Reason given by cardholder for dispute.
Connected_Account_Id	String		For Stripe Connect activity related to a connected account, the unique ID for the account.
Connected_Account_Name	String		For Stripe Connect activity related to a connected account, the name of the account.
Connected_Account_Country	String		For Stripe Connect activity related to a connected account, the two-letter ISO code representing the country of the account.
Regulatory_Tag	String		??An identifier reflecting the classification of this transaction according to local regulations, if applicable. Accounts with automatic payouts enabled receive a separate payout for each regulatory tag. ??This column is only populated for Brazilian accounts.
Payment_Metadata	String		Metadata associated with the related PaymentIntent, if any. If no PaymentIntent metadata exists, metadata from any related charge object will be returned. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys.
Refund_Metadata	String		Metadata associated with the related refund object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys.
Transfer_Metadata	String		Metadata associated with the related transfer object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys.
Id [KEY]	String	Reports.Id	Unique identifier for the reports run object.
ParametersIntervalEnd	Datetime		Ending timestamp of data to be included in the report run (exclusive).
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersCurrency	String		Currency of objects to be included in the report run.
ParametersReportingCategory	String		Category of balance transactions to be included in the report run.
ParametersTimezone	String		Defaults to Etc/UTC. The output timezone for all timestamps in the report.

ItemizedPayoutReconciliationReport

Query the Itemized payout reconciliation report in Stripe.

Table Specific Information

Used to query the Itemized Payout Reconciliation report in Stripe.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Creating the Report

To create a report, the following parameters are required:

ParametersIntervalStart
ParametersIntervalEnd

You can also include the following optional parameters:

ParametersColumns
ParametersCurrency
ParametersTimezone
ParametersReportingCategory

//  This first creates the new Report and displays it. Report Creation takes time once it is created will display the report.
SELECT * FROM ItemizedPayoutReconciliationReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'

Select

You can run the following queries to retrieve report data:

SELECT * FROM ItemizedPayoutReconciliationReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'payout_reconciliation.itemized.4')	
SELECT * FROM ItemizedPayoutReconciliationReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM ItemizedPayoutReconciliationReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report

Columns


Name	Type	References	Description
Balance_Transaction_Id [KEY]	String		Unique identifier for the balance transaction.
Created_UTC	Datetime		Time at which the balance transaction was created. Dates in UTC.
Created	Datetime		Time at which the balance transaction was created. Dates in the requested timezone, or UTC if not provided.
Available_On_UTC	Datetime		The date the balance transactions net funds will become available in the Stripe balance. Dates in UTC.
Available_On	Datetime		The date the balance transactions net funds will become available in the Stripe balance. Dates in the requested timezone, or UTC if not provided.
Currency	String		Three-letter ISO code for the currency in which gross, fee and net are defined.
Gross	Decimal		Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee	Decimal		Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net	Decimal		Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Reporting_Category	String		Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Source_Id	String		The Stripe object to which this transaction is related.
Description	String		An arbitrary string attached to the balance transaction. Often useful for displaying to users.
Customer_Facing_Amount	Decimal		For transactions associated with charges or refunds, the amount of the original charge or refund.
Customer_Facing_Currency	String		For transactions associated with charges or refunds, the three-letter ISO code for the currency for customer_facing_amount.
Automatic_Payout_Id	String		ID of the automatically created payout associated with this balance transaction (only set if your account is on an automatic payout schedule).
Automatic_Payout_Effective_At_UTC	Datetime		The date we expect this automatic payout to arrive in your bank account, in UTC. This is also when the paid-out funds are deducted from your Stripe balance.
Automatic_Payout_Effective_At	Datetime		The date we expect this automatic payout to arrive in your bank account, in the requested timezone, or UTC if not provided. This is also when the paid-out funds are deducted from your Stripe balance.
Customer_Id	String		The unique ID of the related customer, if any.
Customer_Email	String		Email address of the customer, if any, associated with this balance transaction.
Customer_Name	String		Name of the customer, if any, associated with this balance transaction.
Customer_Description	String		Description provided when creating the customer, often used to store the customer name.
Shipping_Address_Line1	String		First line of the shipping address associated with this charge, if any
Shipping_Address_Line2	String		Second line of the shipping address associated with this charge, if any
Shipping_Address_City	String		City of the shipping address associated with this charge, if any
Shipping_Address_State	String		State of the shipping address associated with this charge, if any
Shipping_Address_Postal_Code	String		Postal code of the shipping address associated with this charge, if any
Shipping_Address_Country	String		Country of the shipping address associated with this charge, if any
Charge_Id	String		Unique identifier for the original charge associated with this balance transaction. Available for charges, refunds and disputes.
Payment_Intent_Id	String		The unique ID of the related Payment Intent, if any.
Charge_Created_UTC	Datetime		Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in UTC.
Charge_Created	Datetime		Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in the requested timezone, or UTC if not provided.
Invoice_Id	String		Unique ID for the invoice associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing invoice.
Subscription_Id	String		Unique ID for the subscription associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing subscription.
Payment_Method_Type	String		The type of payment method used in the related payment.
Card_Brand	String		Card brand, if applicable.
Card_Funding	String		Card funding type, if applicable.
Card_Country	String		Two-letter ISO code representing the country of the card.
Statement_Descriptor	String		The dynamic statement descriptor or suffix specified when the related charge was created.
Dispute_Reason	String		Reason given by cardholder for dispute.
Connected_Account_Id	String		For Stripe Connect activity related to a connected account, the unique ID for the account.
Connected_Account_Name	String		For Stripe Connect activity related to a connected account, the name of the account.
Connected_Account_Country	String		For Stripe Connect activity related to a connected account, the two-letter ISO code representing the country of the account.
Regulatory_Tag	String		??An identifier reflecting the classification of this transaction according to local regulations, if applicable. Accounts with automatic payouts enabled receive a separate payout for each regulatory tag. ??This column is only populated for Brazilian accounts.
Payment_Metadata	String		Metadata associated with the related PaymentIntent, if any. If no PaymentIntent metadata exists, metadata from any related charge object will be returned. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys.
Refund_Metadata	String		Metadata associated with the related refund object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys.
Transfer_Metadata	String		Metadata associated with the related transfer object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys.
Id [KEY]	String	Reports.Id	Unique identifier for the reports run object.
ParametersIntervalEnd	Datetime		Ending timestamp of data to be included in the report run (exclusive).
ParametersIntervalStart	Datetime		Starting timestamp of data to be included in the report run.
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersCurrency	String		Currency of objects to be included in the report run.
ParametersReportingCategory	String		Category of balance transactions to be included in the report run.
ParametersTimezone	String		Defaults to Etc/UTC. The output timezone for all timestamps in the report.

ItemizedPayoutsReport

Query the Itemized payouts report in Stripe.

Table Specific Information

Used to query the Itemized Payouts report in Stripe.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Creating the Report

To create a report, the following parameters are required:

ParametersIntervalStart
ParametersIntervalEnd

You can also include the following optional parameters:

ParametersColumns
ParametersCurrency
ParametersTimezone
ParametersReportingCategory

//  This first creates the new Report and displays it. Report Creation takes time once it is created will display the report.
SELECT * FROM ItemizedPayoutsReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'

Select

You can run the following queries to retrieve report data:

SELECT * FROM ItemizedPayoutsReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'payouts.itemized.3')
SELECT * FROM ItemizedPayoutsReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM ItemizedPayoutsReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report

Columns


Name	Type	References	Description
Payout_Id [KEY]	String		The Stripe object to which this transaction is related.
Effective_At_UTC	Datetime		For automatic payouts, this is the date we expect funds to arrive in your bank account. For manual payouts, this is the date the payout was initiated. In both cases, its the date the paid-out funds are deducted from your Stripe balance. All dates in UTC.
Effective_At	Datetime		For automatic payouts, this is the date we expect funds to arrive in your bank account. For manual payouts, this is the date the payout was initiated. In both cases, its the date the paid-out funds are deducted from your Stripe balance. All dates in the requested timezone, or UTC if not provided.
Currency	String		Three-letter ISO code for the currency in which gross, fee and net are defined.
Gross	Decimal		Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee	Decimal		Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net	Decimal		Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Reporting_Category	String		Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Balance_Transaction_Id	String		Unique identifier for the balance transaction.
Description	String		An arbitrary string attached to the balance transaction. Often useful for displaying to users.
Payout_Expected_Arrival_Date	Datetime		Date the payout is scheduled to arrive in the bank. This factors in delays like weekends or bank holidays.
Payout_Status	String		Current status of the payout (paid, pending, in_transit, canceled or failed). A payout will be pending until it is submitted to the bank, at which point it becomes in_transit. It will then change to paid if the transaction goes through. If it does not go through successfully, its status will change to failed or canceled.
Payout_Reversed_At_UTC	Datetime		Typically this field will be empty. However, if the payouts status is canceled or failed, this field will reflect the time at which it entered that status. Times in UTC.
Payout_Reversed_At	Datetime		Typically this field will be empty. However, if the payouts status is canceled or failed, this field will reflect the time at which it entered that status. Times in the requested timezone, or UTC if not provided.
Payout_Type	String		Can be bank_account or card.
Payout_Description	String		An arbitrary string attached to the payout. Often useful for displaying to users.
Payout_Destination_Id	String		ID of the bank account or card the payout was sent to.
Regulatory_Tag	String		??An identifier reflecting the classification of this transaction according to local regulations, if applicable. Accounts with automatic payouts enabled receive a separate payout for each regulatory tag. ??This column is only populated for Brazilian accounts.
Id [KEY]	String	Reports.Id	Unique identifier for the reports run object.
ParametersIntervalEnd	Datetime		Ending timestamp of data to be included in the report run (exclusive).
ParametersIntervalStart	Datetime		Starting timestamp of data to be included in the report run.
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersCurrency	String		Currency of objects to be included in the report run.
ParametersReportingCategory	String		Category of balance transactions to be included in the report run.
ParametersTimezone	String		Defaults to Etc/UTC. The output timezone for all timestamps in the report.

ItemizedReconciliationForASinglePayoutReport

Query the Itemized reconciliation for a single payout report in Stripe.

Table Specific Information

Used to query the itemized reconciliation for a single payout report in Stripe.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Creating the Report

To create a report, the following parameters are required:

ParametersPayout

You can also include the following optional parameters:

ParametersColumns
ParametersTimezone
ParametersReportingCategory

//  This first creates the new Report and displays it. Report Creation takes time once it is created will display the report.
SELECT * FROM ItemizedReconciliationForASinglePayoutReport WHERE ParametersPayout = '123456789'

Select

You can run the following queries to retrieve report data:

SELECT * FROM ItemizedReconciliationForASinglePayoutReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'payout_reconciliation.by_id.itemized.4')
SELECT * FROM ItemizedReconciliationForASinglePayoutReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM ItemizedReconciliationForASinglePayoutReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report

Columns


Name	Type	References	Description
Balance_Transaction_Id	String		Unique identifier for the balance transaction.
Created_UTC	Datetime		Time at which the balance transaction was created. Dates in UTC.
Created	Datetime		Time at which the balance transaction was created. Dates in the requested timezone, or UTC if not provided.
Available_On_UTC	Datetime		The date the balance transactions net funds will become available in the Stripe balance. Dates in UTC.
Available_On	Datetime		The date the balance transactions net funds will become available in the Stripe balance. Dates in the requested timezone, or UTC if not provided.
Currency	String		Three-letter ISO code for the currency in which gross, fee and net are defined.
Gross	Decimal		Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee	Decimal		Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net	Decimal		Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Reporting_Category	String		Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Source_Id	String		The Stripe object to which this transaction is related.
Description	String		An arbitrary string attached to the balance transaction. Often useful for displaying to users.
Customer_Facing_Amount	Decimal		For transactions associated with charges or refunds, the amount of the original charge or refund.
Customer_Facing_Currency	String		For transactions associated with charges or refunds, the three-letter ISO code for the currency for customer_facing_amount.
Automatic_Payout_Id	String		ID of the automatically created payout associated with this balance transaction (only set if your account is on an automatic payout schedule).
Automatic_Payout_Effective_At_UTC	Datetime		The date we expect this automatic payout to arrive in your bank account, in UTC. This is also when the paid-out funds are deducted from your Stripe balance.
Automatic_Payout_Effective_At	Datetime		The date we expect this automatic payout to arrive in your bank account, in the requested timezone, or UTC if not provided. This is also when the paid-out funds are deducted from your Stripe balance.
Customer_Id	String		The unique ID of the related customer, if any.
Customer_Email	String		Email address of the customer, if any, associated with this balance transaction.
Customer_Name	String		Name of the customer, if any, associated with this balance transaction.
Customer_Description	String		Description provided when creating the customer, often used to store the customer name.
Shipping_Address_Line1	String		First line of the shipping address associated with this charge, if any
Shipping_Address_Line2	String		Second line of the shipping address associated with this charge, if any
Shipping_Address_City	String		City of the shipping address associated with this charge, if any
Shipping_Address_State	String		State of the shipping address associated with this charge, if any
Shipping_Address_Postal_Code	String		Postal code of the shipping address associated with this charge, if any
Shipping_Address_Country	String		Country of the shipping address associated with this charge, if any
Charge_Id	String		Unique identifier for the original charge associated with this balance transaction. Available for charges, refunds and disputes.
Payment_Intent_Id	String		The unique ID of the related Payment Intent, if any.
Charge_Created_UTC	Datetime		Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in UTC.
Charge_Created	Datetime		Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in the requested timezone, or UTC if not provided.
Invoice_Id	String		Unique ID for the invoice associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing invoice.
Subscription_Id	String		Unique ID for the subscription associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing subscription.
Payment_Method_Type	String		The type of payment method used in the related payment.
Card_Brand	String		Card brand, if applicable.
Card_Funding	String		Card funding type, if applicable.
Card_Country	String		Two-letter ISO code representing the country of the card.
Statement_Descriptor	String		The dynamic statement descriptor or suffix specified when the related charge was created.
Dispute_Reason	String		Reason given by cardholder for dispute.
Connected_Account_Id	String		For Stripe Connect activity related to a connected account, the unique ID for the account.
Connected_Account_Name	String		For Stripe Connect activity related to a connected account, the name of the account.
Connected_Account_Country	String		For Stripe Connect activity related to a connected account, the two-letter ISO code representing the country of the account.
Id [KEY]	String	Reports.Id	Unique identifier for the reports run object.
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersPayout	String	Payouts.Id	Payout ID by which to filter the report run.
ParametersReportingCategory	String		Category of balance transactions to be included in the report run.
ParametersTimezone	String		Defaults to Etc/UTC. The output timezone for all timestamps in the report.

PaymentLinkLineItems

Query the available PaymentLink line items in Stripe.

Table Specific Information

Select

The Sync App 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 Sync App.

PaymentLinkId supports the following operator: =.
AccountId supports the following operator: =.

You can select from PaymentLinkLineItems with the following queries:

SELECT * FROM PaymentLinkLineItems WHERE PaymentLinkId = 'plink_1MHJbZSC4snQ4WkOqF4MChgG'
SELECT * FROM PaymentLinkLineItems WHERE PaymentLinkId = 'plink_1MHJbZSC4snQ4WkOqF4MChgG' AND AccountId = 'acct_1MGcyqSC4snQ4WkO'

Columns


Name	Type	References	Description
Id [KEY]	String		Id of the PaymentLinkLineItems.
PaymentLinkId	String	PaymentLinks.Id	Payment Links Id.
AmountDiscount	Integer		Total discount amount applied. If no discounts were applied, defaults to 0.
AmountSubtotal	Integer		Total before any discounts or taxes are applied.
AmountTax	Integer		Total tax amount applied. If no tax was applied, defaults to 0.
AmountTotal	Integer		Total after discounts and taxes.
Currency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
Description	String		An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
Object	String		Name of the Object.
PriceActive	Boolean		Whether the price can be used for new purchases.
PriceBillingScheme	String		How to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
PriceCreated	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
PriceCurrency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
PriceCustomUnitAmount	String		When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
PriceId	String		Id of the price.
PriceLivemode	Boolean		True if the object exists in live mode. False if the object exists in test mode.
PriceLookupKey	String		A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
PriceNickname	String		A brief description of the price, hidden from customers.
PriceObject	String		The object name for the price.
PriceProduct	String		The ID of the product this price is associated with.
PriceRecurring	String		The recurring components of a price such as interval and usage_type.
PriceTaxBehavior	String		Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
PriceTiersMode	String		Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme. This field is not included by default. To include it in the response, expand the tiers field.
PriceTransformQuantity	String		Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
PriceType	String		One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
PriceUnitAmount	Integer		The unit amount in paise to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
PriceUnitAmountDecimal	Decimal		The unit amount in paise to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
Quantity	Integer		The quantity of the products being purchased.

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
AdjustableQuantityEnabled	Boolean		Set to true if the quantity can be adjusted to any non-negative Integer.
AdjustableQuantityMinimum	Integer		The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.
AdjustableQuantityMaximum	Integer		The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item quantity cannot go down to 0.
AccountId	String		The Id of the connected account.

PaymentMethodDomains

Lists the details of existing payment method domains.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
DomainName supports the following operator: =.
Enabled supports the following operator: =.

You can select from PaymentMethodDomains with the following queries:

    SELECT * FROM PaymentMethodDomains WHERE id='pmd_1OgQ87SC4snQ4WkOiSNV7rXG'
    SELECT * FROM PaymentMethodDomains WHERE domainname='www.paymentmethod.com'
    SELECT * FROM PaymentMethodDomains WHERE enabled = false

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
DomainName	String		The domain name that this payment method domain object represents.
Enabled	Boolean		Whether this payment method domain is enabled.
ApplePayStatus	String		The status of the payment method on the domain.
ApplePayStatusDetailsErrorMessage	String		The error message associated with the status of the payment method on the domain.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
GooglePayStatus	String		The status of the payment method on the domain.
GooglePayStatusDetailsErrorMessage	String		The error message associated with the status of the payment method on the domain.
LinkStatus	String		The status of the payment method on the domain.
LinkStatusDetailsErrorMessage	String		The error message associated with the status of the payment method on the domain.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Object	String		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
PaypalStatus	String		The status of the payment method on the domain.
PaypalStatusDetailsErrorMessage	String		The error message associated with the status of the payment method on the domain.

PayoutsReconciliationSummaryForASinglePayoutReport

Payouts reconciliation summary for a single payout in Stripe.

Table Specific Information

Used to query the payouts reconciliation summary for a single payout in Stripe.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Creating the Report

To create a report, the following parameters are required:

ParametersPayout

You can also include the following optional parameters:

ParametersColumns

//  This first creates the new Report and displays it. Report Creation takes time once it is created will display the report.
SELECT * FROM PayoutsReconciliationSummaryForASinglePayoutReport WHERE ParametersPayout = '12345678'

Select

You can run the following queries to retrieve report data:

SELECT * FROM PayoutsReconciliationSummaryForASinglePayoutReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'payout_reconciliation.by_id.summary.1')
SELECT * FROM PayoutsReconciliationSummaryForASinglePayoutReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY')// This will show multiple reports
SELECT * FROM PayoutsReconciliationSummaryForASinglePayoutReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report

Columns


Name	Type	References	Description
Reporting_Category	String		Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Currency	String		Three-letter ISO code for the currency in which gross, fee and net are defined.
Count	Int		The number of transactions associated with the reporting_category.
Gross	Decimal		Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee	Decimal		Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net	Decimal		Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Id	String	Reports.Id	Unique identifier for the reports run object.
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersPayout	String	Payouts.Id	Payout ID by which to filter the report run.

PayoutsReconciliationSummaryReport

Query the Payouts reconciliation summary report in Stripe.

Table Specific Information

Used to query the Payouts Reconciliation Summary report in Stripe.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Creating the Report

To create a report, the following parameters are required:

ParametersIntervalStart
ParametersIntervalEnd

You can also include the following optional parameters:

ParametersColumns
ParametersCurrency

//  This first creates the new Report and displays it. Report Creation takes time once it is created will display the report.
SELECT * FROM PayoutsReconciliationSummaryReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'

Select

You can run the following queries to retrieve report data:

SELECT * FROM PayoutsReconciliationSummaryReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'payout_reconciliation.summary.1')
SELECT * FROM PayoutsReconciliationSummaryReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY')// This will show multiple reports
SELECT * FROM PayoutsReconciliationSummaryReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report

Columns


Name	Type	References	Description
Reporting_Category	String		Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Currency	String		Three-letter ISO code for the currency in which gross, fee and net are defined.
Count	Int		The number of transactions associated with the reporting_category.
Gross	Decimal		Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee	Decimal		Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net	Decimal		Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Id	String	Reports.Id	Unique identifier for the reports run object.
ParametersIntervalEnd	Datetime		Ending timestamp of data to be included in the report run (exclusive).
ParametersIntervalStart	Datetime		Starting timestamp of data to be included in the report run.
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersCurrency	String		Currency of objects to be included in the report run.

PayoutsSummaryReport

Query the Payouts summary report in Stripe.

Table Specific Information

Used to query the Payouts Summary report in Stripe.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Creating the Report

To create a report, the following parameters are required:

ParametersIntervalStart
ParametersIntervalEnd

You can also include the following optional parameters:

ParametersColumns
ParametersCurrency

//  This first creates the new Report and displays it. Report Creation takes time once it is created will display the report.
SELECT * FROM PayoutsSummaryReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'

Select

You can run the following queries to retrieve report data:

SELECT * FROM PayoutsSummaryReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'payouts.summary.1')
SELECT * FROM PayoutsSummaryReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM PayoutsSummaryReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report

Columns


Name	Type	References	Description
Reporting_Category	String		Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Currency	String		Three-letter ISO code for the currency in which gross, fee and net are defined.
Count	Int		The number of transactions associated with the reporting_category.
Gross	Decimal		Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee	Decimal		Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net	Decimal		Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Id	String	Reports.Id	Unique identifier for the reports run object.
ParametersIntervalEnd	Datetime		Ending timestamp of data to be included in the report run (exclusive).
ParametersIntervalStart	Datetime		Starting timestamp of data to be included in the report run.
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersCurrency	String		Currency of objects to be included in the report run.

PendingBalance

Query the available balance in Stripe.

Table Specific Information

Select

You can select from PendingBalance with the following queries:

    SELECT * FROM PendingBalance WHERE Currency = 'usd'
    SELECT * FROM PendingBalance WHERE Livemode = true
    SELECT * FROM PendingBalance WHERE SourceTypesCard > 1000
    SELECT * FROM PendingBalance WHERE SourceTypesBankAccount > 5000
    SELECT * FROM PendingBalance WHERE AccountId = 'acct_1Gqj58Ly0qyl5A'

Columns


Name	Type	References	Description
Currency	String		The currency of the balance.
Amount	Integer		The pending amount.
SourceTypesAggregate	String		The source cards.
SourceTypesCard	Integer		The source cards.
SourceTypesBankAccount	Integer		The source Bank Account.
SourceTypesBitcoinReceiver	Integer		The source Bitcoin Receiver.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.

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 to get pending balance for.

Reports

To Create and Query the Report Run object, which represents an instance of a report type generated with specific run parameters.

Table Specific Information

Used to query all the reports or a specific report.

Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operators: =, IN.

You can select from Reports with the following queries:

    SELECT * FROM Reports WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x'
    SELECT * FROM Reports WHERE Id IN ('frr_1I14hXATXQzBWNrlGP5pSxd9', 'frr_1I14h9ATXQzBWNrlEG32QcPH')

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
Error	String		If something should go wrong during the run, a message about the failure (populated when status=failed).
Livemode	Boolean		Always true: reports can only be run on live-mode data
Object	String		String representing the objects type. Objects of the same type share the same value.
ParametersIntervalEnd	Datetime		Ending timestamp of data to be included in the report run (exclusive).
ParametersIntervalStart	Datetime		Starting timestamp of data to be included in the report run.
ParametersColumns	String		The set of output columns requested for inclusion in the report run.
ParametersConnectedAccount	String		Connected account ID by which to filter the report run.
ParametersCurrency	String		Currency of objects to be included in the report run.
ParametersPayout	String	Payouts.Id	Payout ID by which to filter the report run.
ParametersReportingCategory	String		Category of balance transactions to be included in the report run.
ParametersTimezone	String		Defaults to Etc/UTC. The output timezone for all timestamps in the report.
Report_type	String		The ID of the report type to run, such as balance.summary.1 The allowed values are balance_change_from_activity.itemized.1, balance_change_from_activity.itemized.2, balance_change_from_activity.itemized.3, balance_change_from_activity.summary.1, payouts.itemized.1, payouts.itemized.2, payouts.itemized.3, payouts.summary.1, balance.summary.1, ending_balance_reconciliation.itemized.1, ending_balance_reconciliation.itemized.2, ending_balance_reconciliation.itemized.3, ending_balance_reconciliation.summary.1, ending_balance_reconciliation.itemized.4, payout_reconciliation.by_id.itemized.1, payout_reconciliation.by_id.itemized.2, payout_reconciliation.by_id.itemized.3, payout_reconciliation.by_id.itemized.4, payout_reconciliation.by_id.summary.1, payout_reconciliation.itemized.1, payout_reconciliation.itemized.2, payout_reconciliation.itemized.3, payout_reconciliation.itemized.4, payout_reconciliation.summary.1, payout_reconciliation.itemized.5.
ResultCreated	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
ResultExpiresAt	Datetime		The time at which the file expires and is no longer available in epoch seconds.
ResultFilename	String		A filename for the file, suitable for saving to a filesystem.
ResultId	String		Unique identifier for the object.
ResultLinksHas_more	Boolean		True if this list has another page of items after this one that can be fetched.
ResultLinksObject	String		String representing the objects type. Objects of the same type share the same value. Always has the value list.
ResultLinksUrl	String		The URL where this list can be accessed.
ResultObject	String		String representing the objects type. Objects of the same type share the same value.
ResultPurpose	String		The purpose of the uploaded file. The allowed values are account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, identity_document, pci_document, tax_document_user_upload.
ResultSize	Integer		The size in bytes of the file object.
ResultTitle	String		A user friendly title for the document.
ResultType	String		The type of the file returned (e.g., csv, pdf, jpg, or png).
ResultUrl	String		The URL from which the file can be downloaded using your live secret API key.
Status	String		Status of this report run. This will be pending when the run is initially created. When the run finishes, this will be set to succeeded and the result field will be populated. Rarely, we may encounter an error, at which point this will be set to failed and the error field will be populated.
Succeeded_at	Timestamp		Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch.
ResultLinksDataAggregate	String		Details about each object of Result Links.

ReportTypes

To query the available report types.

Table Specific Information

Used to query all the report types or a specific report type.

Note: This report type requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operators: =, IN.

You can select from ReportTypes with the following queries:

	SELECT * FROM ReportTypes
    SELECT * FROM ReportTypes WHERE Id = 'balance.summary.1'
    SELECT * FROM ReportTypes WHERE Id IN ('balance.summary.1', 'balance_change_from_activity.itemized.1')

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the Report Type, such as balance.summary.1.
Object	String		String representing the object's type. Objects of the same type share the same value.
DataAvailableEnd	Datetime		Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
DataAvailableStart	Datetime		Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
DefaultColumns	String		List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the columns parameter, this will be null.)
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Name	String		Human-readable name of the Report Type.
Updated	Datetime		When this Report Type was latest updated. Measured in seconds since the Unix epoch.
Version	Integer		Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.

Reviews

Queries the reviews.

Table Specific Information

Select

The Sync App uses the Stripe API to filter the results by the following columns and operators:

Id and AccountId supports the following operator: =.
Created supports the following operators: >, >=, <, <=, =.

The rest of the filter is executed client-side within the Sync App.

You can select from Reviews with the following queries:

    SELECT * FROM Reviews WHERE Id = '123321'
    SELECT * FROM Reviews WHERE Created >= '2023-07-14T05:36:46.000-04:00'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the reviews.
BillingZip	String		The ZIP or postal code of the card used, if applicable.
Charge	String		The charge associated with this review.
ClosedReason	String		The reason the review was closed, or null if it has not yet been closed.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
IpAddress	String		The IP address where the payment originated.
IpAddressLocation	String		Information related to the location of the payment.
Livemode	Boolean		true if the object exists in live mode andfalse if in test mode.
Open	Boolean		If true, the review needs action.
OpenedReason	String		The reason the review was opened. Either rule or manual.
PaymentIntent	String		The PaymentIntent ID associated with this review, if one exists.
Reason	String		The reason the review is currently open or closed. Possible values are rule, manual, approved, refunded, refunded_as_fraud, disputed, or redacted.
Session	String		Information related to the browsing session of the user who initiated the payment.

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 to be reviewed.

SetupAttempts

Returns a list of SetupAttempts that associate with a provided SetupIntent.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
SetupIntent supports the following operator: =.

You can select from SetupAttempts with the following queries:

    SELECT * FROM SetupAttempts WHERE Id = 'setupatt_1GhPzLJXTn'
    SELECT * FROM SetupAttempts WHERE setupintent = 'seti_1Ogg5h2eZvKYlo2CRdyp2Ggk'
    SELECT * FROM SetupAttempts WHERE Status = 'succeeded'
    SELECT * FROM SetupAttempts WHERE Created >= '2024-01-01'
    SELECT * FROM SetupAttempts WHERE Livemode = true

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
Object	String		String representing the objects type. Objects of the same type share the same value.
Application	String		The value of application on the SetupIntent at the time of this confirmation.
AttachToSelf	Boolean		If present, the SetupIntents payment method will be attached to the in-context Stripe Account.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
Customer	String		The value of customer on the SetupIntent at the time of this confirmation.
FlowDirections	String		Indicates the directions of money movement for which this payment method is intended to be used.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
OnBehalfOf	String		The value of on_behalf_of on the SetupIntent at the time of this confirmation.
PaymentMethod	String		ID of the payment method used with this SetupAttempt.
PaymentMethodDetailsAcssDebit	String		If this is a acss_debit payment method, this hash contains confirmation-specific information for the acss_debit payment method.
PaymentMethodDetailsAuBecsDebit	String		If this is a au_becs_debit payment method, this hash contains confirmation-specific information for the au_becs_debit payment method.
PaymentMethodDetailsBacsDebit	String		If this is a bacs_debit payment method, this hash contains confirmation-specific information for the bacs_debit payment method.
PaymentMethodDetailsBanContactBankCode	String		Bank code of bank associated with the bank account.
PaymentMethodDetailsBanContactBankName	String		Name of the bank associated with the bank account.
PaymentMethodDetailsBanContactBIC	String		Bank Identifier Code of the bank associated with the bank account.
PaymentMethodDetailsBanContactGeneratedSepaDebit	String		The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
PaymentMethodDetailsBanContactGeneratedSepaDebitMandate	String		The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
PaymentMethodDetailsBanContactIBanLast4	String		Last four characters of the IBAN.
PaymentMethodDetailsBanContactPreferredLanguage	String		Preferred language of the Bancontact authorization page that the customer is redirected to
PaymentMethodDetailsBanContactVerifiedName	String		Owners verified full name.
PaymentMethodDetailsBoleto	String		If this is a boleto payment method, this hash contains confirmation-specific information for the boleto payment method.
PaymentMethodDetailsCardBrand	String		Card brand.
PaymentMethodDetailsCardChecks	String		Check results by Card networks on Card address and CVC at the time of authorization
PaymentMethodDetailsCardCountry	String		Two-letter ISO code representing the country of the card.
PaymentMethodDetailsCardExpMonth	String		Two-digit number representing the cards expiration month.
PaymentMethodDetailsCardExpYear	String		Four-digit number representing the cards expiration year.
PaymentMethodDetailsCardFingerprint	String		Uniquely identifies this particular card number.
PaymentMethodDetailsCardFunding	String		Card funding type.
PaymentMethodDetailsCardLast4	String		The last four digits of the card.
PaymentMethodDetailsCardNetwork	String		Identifies which network this charge was processed on.
PaymentMethodDetailsCardThreeDSecure	String		Populated if this authorization used 3D Secure authentication.
PaymentMethodDetailsCardWallet	String		If this Card is part of a card wallet, this contains the details of the card wallet.
PaymentMethodDetailsCardPresent	String		If this is a card_present payment method, this hash contains confirmation-specific information for the card_present payment method.
PaymentMethodDetailsCashApp	String		If this is a cashapp payment method, this hash contains confirmation-specific information for the cashapp payment method.
PaymentMethodDetailsIdealBank	String		The customers bank.
PaymentMethodDetailsIdealBIC	String		The Bank Identifier Code of the customers bank.
PaymentMethodDetailsIdealGeneratedSepaDebit	String		The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
PaymentMethodDetailsIdealGeneratedSepaDebitMandate	String		The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
PaymentMethodDetailsIdealIBanLast4	String		Last four characters of the IBAN.
PaymentMethodDetailsIdealVerifiedName	String		Owners verified full name.
PaymentMethodDetailsKlarna	String		If this is a klarna payment method, this hash contains confirmation-specific information for the klarna payment method.
PaymentMethodDetailsLink	String		If this is a link payment method, this hash contains confirmation-specific information for the link payment method
PaymentMethodDetailsPaypal	String		If this is a paypal payment method, this hash contains confirmation-specific information for the paypal payment method.
PaymentMethodDetailsSepaDebit	String		If this is a sepa_debit payment method, this hash contains confirmation-specific information for the sepa_debit payment method.
PaymentMethodDetailsSoFortBankCode	String		Bank code of bank associated with the bank account.
PaymentMethodDetailsSoFortBankName	String		Name of the bank associated with the bank account.
PaymentMethodDetailsSoFortBIC	String		Bank Identifier Code of the bank associated with the bank account.
PaymentMethodDetailsSoFortGeneratedSepaDebit	String		The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
PaymentMethodDetailsSoFortGeneratedSepaDebitMandate	String		The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
PaymentMethodDetailsSoFortIBanLast4	String		Last four characters of the IBAN.
PaymentMethodDetailsSoFortPreferredLanguage	String		Preferred language of the Sofort authorization page that the customer is redirected to.
PaymentMethodDetailsSoFortVerifiedName	String		Owners verified full name.
PaymentMethodDetailsType	String		The type of the payment method used in the SetupIntent
PaymentMethodDetailsUsBankAccount	String		If this is a us_bank_account payment method, this hash contains confirmation-specific information for the us_bank_account payment method.
SetupErrorCode	String		For some errors that could be handled programmatically, a short string indicating the error code reported.
SetupErrorDeclineCode	String		For card errors resulting from a card issuer decline, a short string indicating the card issuers reason for the decline if they provide one.
SetupErrorDocURL	String		A URL to more information about the error code reported.
SetupErrorMessage	String		A human-readable message providing more details about the error.
SetupErrorParam	String		If the error is parameter-specific, the parameter related to the error.
SetupErrorPaymentMethod	String		The PaymentMethod object for errors returned on a request involving a PaymentMethod.
SetupErrorPaymentMethodType	String		If the error is specific to the type of payment method, the payment method type that had a problem.
SetupErrorType	String		The type of error returned.
SetupIntent	String		ID of the SetupIntent that this attempt belongs to.
Status	String		Status of this SetupAttempt
Usage	String		The value of usage on the SetupIntent at the time of this confirmation

SetupIntents

Returns a list of SetupIntents.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Customer supports the following operator: =.
PaymentMethod supports the following operator: =.
AttachToSelf supports the following operator: =.
Created supports the following operator: =.

You can select from SetupIntents with the following queries:

    SELECT * FROM SetupIntents
    SELECT * FROM SetupIntents where Customer = 'cus_PEW7WrieLzCMkW'
    SELECT * FROM SetupIntents WHERE PaymentMethod = 'pm_1GhPzLJXTn'
    SELECT * FROM SetupIntents WHERE AttachToSelf = true
    SELECT * FROM SetupIntents WHERE Created >= '2024-01-01'

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
AutomaticPaymentMethodsAllowRedirects	String		Controls whether this SetupIntent will accept redirect-based payment methods.
AutomaticPaymentMethodsEnabled	Boolean		Automatically calculates compatible payment methods
Application	String		ID of the Connect application that created the SetupIntent.
AttachToSelf	Boolean		If present, the SetupIntent’s payment method will be attached to the in-context Stripe Account.
CancellationReason	String		Reason for cancellation of this SetupIntent
ClientSecret	String		The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
Created	Integer		Time at which the object was created. Measured in seconds since the Unix epoch.
Customer	String		ID of the Customer this SetupIntent belongs to
Description	String		An arbitrary string attached to the object. Often useful for displaying to users.
FlowDirections	String		Indicates the directions of money movement for which this payment method is intended to be used.
LastSetupErrorCode	String		For some errors that could be handled programmatically, a short string indicating the error code reported.
LastSetupErrorDeclineCode	String		For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one.
LastSetupErrorDocURL	String		A URL to more information about the error code reported.
LastSetupErrorMessage	String		A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
LastSetupErrorParam	String		If the error is parameter-specific, the parameter related to the error.
LastSetupErrorPaymentMethod	String		The PaymentMethod object for errors returned on a request involving a PaymentMethod.
LastSetupErrorPaymentMethodType	String		If the error is specific to the type of payment method, the payment method type that had a problem.
LastSetupErrorType	String		The type of error returned.
MetadataAggregate	String		The set of key/value pairs that you can attach to a an object.
LatestAttempt	String		The most recent SetupAttempt for this SetupIntent.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Mandate	String		ID of the multi use Mandate generated by the SetupIntent.
NextAction	String		If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
PaymentMethod	String		ID of the payment method used with this SetupIntent.
Status	String		Status of this SetupIntent
Usage	String		Indicates how the payment method is intended to be used in the future.
Object	String		String representing the objects type. Objects of the same type share the same value.
OnBehalfOf	String		The account (if any) for which the setup is intended.
PaymentMethodConfigurationDetailsId	String		ID of the payment method configuration used.
PaymentMethodConfigurationDetailsParent	String		ID of the parent payment method configuration used.
PaymentmethodOptions	String		Payment method-specific configuration for this SetupIntent.
PaymentMethodTypes	String		The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.
SingleUseMandate	String		ID of the single_use Mandate generated by the SetupIntent.

SubscriptionSchedules

Retrieves the list of your subscription schedules.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Customer supports the following operator: =.
CanceledAt supports the following operator: =.
CompletedAt supports the following operator: =.
Created supports the following operator: =.
ReleasedAt supports the following operator: =.

You can select from SubscriptionSchedules with the following queries:

    SELECT * FROM SubscriptionSchedules WHERE Id = 'sub_sched_1GhPzLJXTn'
    SELECT * FROM SubscriptionSchedules WHERE Customer = 'cus_PEW7WrieLzCMkW'
    SELECT * FROM SubscriptionSchedules WHERE Created = '2024-01-18 02:16:47.0'
    SELECT * FROM SubscriptionSchedules WHERE Status = 'active'

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
Application	String		ID of the Connect Application that created the schedule.
CanceledAt	Datetime		Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
CompletedAt	Datetime		Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
CurrentPhaseEndDate	Datetime		The end of this phase of the subscription schedule.
CurrentPhaseStartDate	Datetime		The start of this phase of the subscription schedule.
Customer	String		ID of the customer who owns the subscription schedule.
MetadataAggregate	String		The set of key/value pairs that you can attach to a an object.
Phases	String		Configuration for the subscription schedules phases.
Status	String		The present status of the subscription schedule.
Subscription	String		ID of the subscription managed by the subscription schedule.
Object	String		String representing the objects type. Objects of the same type share the same value.
DefaultSettingsApplicationFeePercent	Decimal		A non-negative decimal between 0 and 100, with at most two decimal places.
DefaultSettingsAutomaticTaxEnabled	Boolean		Whether Stripe automatically computes tax on invoices created during this phase.
DefaultSettingsAutomaticTaxLiability	String		The account thats liable for tax.
DefaultSettingsBillingCycleAnchor	String		Possible values are phase_start or automatic.
DefaultSettingsBillingThresholds	String		Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
DefaultSettingsCollectionMethod	String		Either charge_automatically, or send_invoice.
DefaultSettingsDefaultPaymentMethod	String		ID of the default payment method for the subscription schedule.
DefaultSettingsDescription	String		Subscription description, meant to be displayable to the customer.
DefaultSettingsInvoiceSettings	String		The subscription schedules default invoice settings.
DefaultSettingsOnBehalfOf	String		The account (if any) the charge was made on behalf of for charges associated with the schedules subscription.
DefaultSettingsTransferData	String		The account (if any) the associated subscriptions payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscriptions invoices.
EndBehavior	String		Behavior of the subscription schedule and underlying subscription when it ends.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
ReleasedAt	Datetime		Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
ReleasedSubscription	String		ID of the subscription once managed by the subscription schedule (if it is released).
TestClock	String		ID of the test clock this subscription schedule belongs to.
RenewalInterval	String		The renewal interval of the subscription schedule.

TaxCodes

Queries the tax codes which classify goods and services for tax purposes.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.

You can select:

All tax codes:

SELECT * FROM TaxCodes

A tax code by specifying its Id:

SELECT * FROM TaxCodes WHERE Id = 'txcd_50021103'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the tax codes.
Description	String		A detailed description of which types of products the tax code represents.
Name	String		A short name for the tax code.
Object	String		String representing the object’s type. Objects of the same type share the same value.

Transactions

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Table Specific Information

Select

Server-Side Query Support

The Sync App 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 Sync App.

Id supports the following operator: =.
Card supports the following operator: =.
Cardholder supports the following operator: =.
Type supports the following operator: =.
Created supports the following operator: =.

You can select from Transactions with the following queries:

    SELECT * FROM Transactions WHERE Id = 'ipi_1ODMLL2eZvKYlo2CoarGZSSp'
    SELECT * FROM Transactions WHERE Card = 'card_1GhPzLJXTn'
    SELECT * FROM Transactions WHERE Cardholder = 'cardholder_12345'
    SELECT * FROM Transactions WHERE Type = 'purchase'
    SELECT * FROM Transactions WHERE Created >= '2024-01-01'

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
Amount	Integer		The transaction amount, which will be reflected in your balance.
AmountDetailsAtmFee	Integer		The fee charged by the ATM for the cash withdrawal.
AmountDetailsCashbackAmount	Integer		The amount of cash requested by the cardholder.
Authorization	String		The Authorization object that led to this transaction.
BalanceTransaction	String		Balance transaction that describes the impact on your account balance.
Card	String		The card used to make this transaction.
Cardholder	String		The cardholder to whom this transaction belongs.
Currency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
MetadataAggregate	String		The set of key/value pairs that you can attach to a an object.
Type	String		The nature of the transaction.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
Dispute	String		If youve disputed the transaction, the ID of the dispute.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
MerchantAmount	Integer		The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit
MerchantCurrency	String		The currency with which the merchant is taking payment.
MerchantDataCategory	String		A categorization of the seller’s type of business.
MerchantDataCategoryCode	String		The merchant category code for the sellers business
MerchantDataCity	String		City where the seller is located
MerchantDataCountry	String		Country where the seller is located
MerchantDataName	String		Name of the seller
MerchantDataNetworkId	String		Identifier assigned to the seller by the card network.
MerchantDataPostalCode	String		Postal code where the seller is located
MerchantDataState	String		State where the seller is located
MerchantDataTerminalId	String		An ID assigned by the seller to the location of the sale.
MerchantDataURL	String		URL provided by the merchant on a 3DS request
NetworkDataAuthorizationCode	String		A code created by Stripe which is shared with the merchant to validate the authorization.
NetworkDataProcessingDate	String		The date the transaction was processed by the card network.
NetworkDataTransactionId	String		Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
PurchaseDetailsFlight	String		Information about the flight that was purchased with this transaction.
PurchaseDetailsFuel	String		Information about fuel that was purchased with this transaction.
PurchaseDetailsLodging	String		Information about lodging that was purchased with this transaction.
PurchaseDetailsReceipt	String		The line items in the purchase.
PurchaseDetailsReference	String		A merchant-specific order number.
Token	String		Token object used for this transaction.
Wallet	String		The digital wallet used for this transaction.

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 to get files for.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
AuthScheme	The type of authentication to use when connecting to Stripe.

OAuth

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthAccessToken	A token received after authentication to the OAuth network, granting the user access. The access token is used in place of the user's login ID and password, which stay on the server.

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

Property	Description
AccountId	The ID of the Account that you want to use.
LiveAPIKey	LiveAPIKey is required to generate and view the Reports.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
AuthScheme	The type of authentication to use when connecting to Stripe.

AuthScheme

The type of authentication to use when connecting to Stripe.

Remarks

APIKey: Set to this to perform APIKey authentication.
OAuth: Set to this to perform OAuth authentication.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthAccessToken	A token received after authentication to the OAuth network, granting the user access. The access token is used in place of the user's login ID and password, which stay on the server.

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

OAuthAccessToken

A token received after authentication to the OAuth network, granting the user access. The access token is used in place of the user's login ID and password, which stay on the server.

Remarks

The OAuth access token has a server-dependent timeout, limiting user access. This is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The Sync App uses these properties to determine when the token expires so it can refresh most efficiently.

If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the Sync App refreshes the token immediately.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Stripe. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Stripe. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Stripe. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\Stripe Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
AccountId	The ID of the Account that you want to use.
LiveAPIKey	LiveAPIKey is required to generate and view the Reports.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

AccountId

The ID of the Account that you want to use.

Remarks

By default the provider uses the authenticated account.

LiveAPIKey

LiveAPIKey is required to generate and view the Reports.

Remarks

LiveAPIKey is required to generate and view the Reports.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
	"MyView": {
		"query": "SELECT * FROM Customers WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Stripe Connector for CData Sync

Stripe Connector for CData Sync

Overview

Stripe Version Support

Establishing a Connection

Adding a Connection to Stripe

Connecting to Stripe

Live API Key

OAuth

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

Views

Stored Procedures

Tables

Stripe Connector for CData Sync Tables

Accounts

Table Specific Information

Select

Server-Side Query Support

Insert

Update

Delete

Columns

Pseudo-Columns

BankAccounts

Table Specific Information

Select

Server-Side Query Support

Insert

Update

Delete

Columns

Pseudo-Columns

BankAccountTokens

Table Specific Information

Select

Server-Side Query Support

Insert

Update

Delete

Columns

Pseudo-Columns

Cards

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

CardTokens

Table Specific Information

Select

Server-Side Query Support

Insert

Update

Delete

Columns

Pseudo-Columns

Charges

Table Specific Information

Select

Server-Side Query Support

Insert

Update

Delete

Columns

Pseudo-Columns