Establishing a Connection

Create a connection to Stripe by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Stripe icon is not available, click the Add More icon to download and install the Stripe connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Stripe

You can optionally set the following to refine the data returned from Stripe.

AccountId: Set this to the Connected Account Id which you would like to get data for. To get the account Id, navigate to the stripe dashboard and click on connected accounts from the left hand menu. You can get the account id from the connected accounts list.

Authenticating to Stripe

Stripe supports both the OAuth authentication standard, and authenticating with an API Key.

Live API Key

Set the AuthScheme to APIKey. From the Stripe dashboard, navigate to Developers --> API keys --> Secret key --> Reveal live API Key and set LiveAPIKey to this value.

OAuth

.

AuthScheme - Set this to OAuth.

CData embeds an OAuth application into the Sync App so you can connect without setting any connection properties for your user credentials. When you connect, the Sync App opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The Sync App then completes the OAuth process. For more information on the Embedded Credentials or information on creating a custom OAuth application, refer to our Using OAuth Authentication guide.

Advanced Features

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

User Defined Views

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

SSL Configuration

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

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

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

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 into a list of tables that can be queried using standard SQL statements.

Generally, querying Stripe tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

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.
Coupons	Get and delete the available discount of a Subscription.
CustomerDiscounts	Get and delete the available discount of a Customer.
Customers	Create, update, delete, and query the available Customers in Stripe.
InvoiceItems	Create, update, delete, and query the available invoices items in Stripe.
Invoices	Create, update, delete, and query the available Invoices in Stripe.
PaymentLinks	Create, update, and query the PaymentLinks in Stripe.
PaymentMethods	Create, update and query the available PaymentMethods in Stripe.
Payouts	Query the available Payouts in Stripe.
Plans	Create, update, delete, and query the available Plans in Stripe.
Prices	Create, update, and query the available prices in Stripe.
Refunds	Create and query the available refunds in Stripe.
SubscriptionDiscounts	Get and delete the available discount of a Subscription.
SubscriptionItems	Create, update, delete, and query the available subscription items in Stripe.
Subscriptions	Create, update, delete, and query the available Subscriptions in Stripe.
TransferReversals	Create, update, and query the available reversals belonging to a specific transfer.
Transfers	Create, update, and query the available transfers in Stripe.

Accounts

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

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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: =.

The provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve an Account by specifying its Id:

SELECT * FROM Accounts WHERE Id='MyId'

Insert

To create a new account, Email is required if Managed is not specified or is set to false and Capabilities is required. Capabilities is an aggregate column. See the example below on how to insert into this column.

INSERT INTO Accounts (Capabilities, Country, Email, Managed) VALUES ('{"0": "card_payments","1": "transfers"}', 'US','[email protected]',false)

INSERT INTO Accounts(Capabilities, Country, DefaultCurrency, DetailsSubmitted,Email,Type) VALUES ('{"card_payments": "inactive","transfers": "inactive"}', 'US', 'usd',false, '[email protected]','custom')

Update

To update an Account, specify Id of the Account:

UPDATE Accounts SET BusinessName = 'My Business Name', BusinessPrimaryColor = '#666666', SupportPhone = '+355696977888' WHERE Id = 'acct_1A0XVyFF36eOzuU5'

Delete

To delete an Account, specify the Id of the account.

DELETE FROM Account 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	False		Time at which the account was connected.
DefaultCurrency	String	False		The currency this account has chosen to use as the default.
DetailsSubmitted	Boolean	False		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	False		External accounts (bank accounts and/or cards) currently attached to this account.
FutureRequirementsAggregate	String	False		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	False		Options for customizing how the account functions within Stripe.
BusinessSupportEmail	String	False		The publicly shareable email address that can be reached for support for this account.
BusinessSupportPhone	String	False		The publicly visible support phone number for the business.
BusinessSupportAddressCity	String	False		City, district, suburb, town, or village.
BusinessSupportAddressCountry	String	False		Two-letter country code.
BusinessSupportAddressLine1	String	False		Address line 1 (e.g., street, PO Box, or company name).
BusinessSupportAddressLine2	String	False		Address line 2 (e.g., apartment, suite, unit, or building).
BusinessSupportAddressPostalCode	String	False		ZIP or postal code.
BusinessSupportAddressState	String	False		State, county, province, or region.
BusinessSupportUrl	String	False		The publicly shareable URL that can be reached for support for this account
BusinessProductDescription	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.
BusinessMcc	String	False		The merchant category code for the account.
BusinessName	String	False		The publicly visible name of the business.
BusinessUrl	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	False		When payments collected will be 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	False		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.
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
CompanyStructure	String	False		The category identifying the legal structure of the company or legal entity.
CompanyTaxIdProvided	Boolean	False		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	False		Whether the company's business VAT number was provided.
CompanyVerificationAggregate	String	False		A document for the company.
IndividualId	String	False		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.
IndividualFutureRequirementsAggregate	String	True		nformation about future requirements for the individual.
IndividualGender	String	False		The individual's gender.
IndividualIdNumberProvided	Boolean	False		Whether the individual's personal ID number was provided..
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).
IndividualVerificationAggregate	String	False		The individual's verification document information.

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

BankAccounts

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

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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: =

To query BankAccounts table, CustomerId is required:

SELECT * FROM BankAccounts WHERE CustomerId = 'cus_12345678'

In addition to CustomerId, provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve a Bank Account by specifying its Id:

SELECT * FROM BankAccounts WHERE Id = 'ba_12345678' AND CustomerId = 'cus_12345678'

Insert

To create a new Bank Account, specify Country, Currency, and AccountNumber. CustomerId is required.

INSERT INTO BankAccounts (CustomerId, Country, Currency, AccountHolderName, AccountHolderType, AccountNumber, RoutingNumber) VALUES ('cus_1kghj5755loee', 'US' , 'usd', 'Sab nu' , 'individual', '000123456789','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	True		The customer id this account belongs to.
Account	String	False		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	False		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	False		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	False		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.
AvailablePayoutMethods	String	False		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
Token	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 will use 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 BankAccountTokens table, the Id of desired token is required:

SELECT * FROM BankAccountTokens WHERE Id='btok_12345678'

Insert

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

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

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the token.
BankAccountId	String	False		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	False		Name of the bank associated with the routing number.
Fingerprint	String	False		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	False		The IP address of the client that generated the token.
Created	Datetime	True		The datetime of the token.
Used	Boolean	False		Whether or not this token has already been used.
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.
Type	String	False		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 is a deprecated object. Use PaymentMethods table instead of Cards table.

Select

Server-Side Query Support

The Sync App will use 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: =.

To query Cards table, CustomerId is required:

SELECT * FROM Cards WHERE CustomerId='cus_12345678'

In addition to CustomerId, provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve a Card by specifying its Id:

SELECT * FROM Cards WHERE CustomerId = 'cus_12345678' AND Id = 'ca_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' )

Update

To update a Card, specify both 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 for a Customer, specify both Id and CustomerId:

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

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The card Id.
CustomerId [KEY]	String	False		The customer Id this card belongs to.
ExpMonth	Integer	False		The card expire month.
ExpYear	Integer	False		The card expire 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	False		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	False		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	False		If AddressZip was provided. Possible values: pass, fail, unavailable, or unchecked.
Brand	String	False		Card brand.
Country	String	False		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	False		If a CVC was provided. Possible values: pass, fail, unavailable, or unchecked.
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 expire year.
Fingerprint	String	False		Uniquely identifies this particular card number.
Funding	String	False		Card funding type.
Last4	String	True		Last 4 digits of the card.
Name	String	False		Cardholder name.
Recipient	String	False		The recipient that this card belongs to.
TokenizationMethod	String	False		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.

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 will use 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 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)

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	False		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	False		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	False		If address_zip was provided.
Brand	String	False		The card brand.
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.
CvcCheck	String	False		If a CVC was provided.
DynamicLast4	String	False		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	False		Uniquely identifier.
Funding	String	False		Card funding type.
Name	String	False		Cardholder name.
MetadataAggregate	String	False		The card metadata object.
TokenizationMethod	String	True		If the card number is tokenized, this is the method that was used.
ClientIp	String	False		The IP address of the client that generated the token.
Created	Datetime	True		The datetime of the token.
Used	Boolean	False		Whether or not this token has already been used.
Number	String	False		The card number.
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.
Type	String	False		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 will use 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, CustomerId, Created, and Source support the following operators: <,>>=,<,<=,=.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-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	False		The application fee (if any) for the charge.
ApplicationFeeAmount	Integer	False		The amount of the application fee (if any) for the charge.
BalanceTransaction	String	False		The Id of the balance transaction that describes the impact of this charge on your account balance .
BillingDetailsAggregate	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.
Destination	String	False		The account (if any) the charge was made on behalf of.
Disputed	Boolean	False		Whether the charge has been disputed.
DisputeId	String	True		The ID of the associated dispute.
FailureCode	String	False		The error code explaining the reason for the charge failure if available.
FailureMessage	String	False		The message to the user further explaining the reason for the charge failure if available.
FraudDetailsAggregate	String	False		Information on fraud assessments for the charge.
Invoice	String	False		The Id of the invoice this charge is for if one exists.
Livemode	Boolean	False		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	False		The transaction number that appears on email receipts sent for this charge.
ReceiptURL	String	False		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 will be stylized as an Invoice receipt.
Refunded	Boolean	False		Whether or not the charge has been fully refunded.
RefundsAggregate	String	False		The list of refunds that have been applied to the charge.
Review	String	False		ID of the review associated with this charge if one exists.
ShippingAggregate	String	True		Shipping information for the charge.
SourceAggregate	String	False		The source of every charge is a credit or debit card.
SourceTransfer	String	False		The transfer Id that created this charge.
StatementDescriptor	String	False		The extra information about a charge.
Status	String	False		The status of the payment is either succeeded, pending, or failed.
Transfer	String	False		The Id of the transfer to the destination account.
TransferDataAggregate	String	True		An optional dictionary including the account to automatically transfer to as part of a destination charge.
TransferGroup	String	True		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	False		String representing the object's type. Objects of the same type share the same value.
AmountCaptured	Integer	False		Amount in cents captured
Application	String	False		ID of the Connect application that created the charge.
FailureBalanceTransaction	String	False		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.

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

Coupons

Get and delete the available discount of a Subscription.

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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 CreatedAt support the following operators <,>>=,<,<=,=.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-Coupons list:

SELECT * FROM Coupons

-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

Update is not supported.

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		One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
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 will be 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 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	False		Number of times this coupon has been applied to a customer.
Object	String	False		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	False		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
AccountId	String	The Id of the connected account to get coupons for.

CustomerDiscounts

Get and delete the available discount of a Customer.

Table Specific Information

Select

Server-Side Query Support

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

CustomerId supports the following operator: =.

The provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-Customers Discount list:

SELECT * FROM CustomerDiscounts WHERE CustomerId = 'cus_155dae52s'

Insert

Insert is not supported.

Update

Update is not supported.

Delete

To delete a discount for a Customer, specify the CustomerId:

DELETE FROM CustomerDiscounts WHERE CustomerId = 'cus_155dae52s'

Columns


Name	Type	ReadOnly	References	Description
CustomerId [KEY]	String	False		The id of the subscription.
CouponId	String	False		The id of the coupon.
CreatedAt	Datetime	False		The creation date.
Start	Datetime	False		If the subscription has a trial, the beginning of that trial.
End	Datetime	False		If the subscription has a trial, the end of that trial.
Invoice	String	False		The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
InvoiceItem	String	False		The invoice item id (or invoice line item id for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
Subscription	String	False		The subscription that this coupon is applied to, if it is applied to a particular subscription.
PromotionCode	String	False		The promotion code applied to create this discount.The promotion code applied to create this discount.
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		One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
Name	String	False		Name of the coupon displayed to customers on for instance invoices or receipts.
DurationInMonths	Integer	False		the number of months the coupon applies.
AmountOff	Integer	False		Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
PercentOff	Integer	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 percent_off of 50 will make a $100 invoice $50 instead.
Valid	Boolean	False		Taking account of the above properties, whether this coupon can still be applied to a customer.
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.
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.
TimesRedeemed	Integer	False		Number of times this coupon has been applied to a customer.
MetadataAggregate	String	False		Set of key-value pairs that you can attach to 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 customer discounts for

Customers

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

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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, Created, and Email support the following operators: <,>>=,<,<=,=.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-a Customer by specifying its 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, at least Email or Description is required:

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 will be discounted:

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

Update

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

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

To apply a discount to an existing customer, set the DiscountId field to the CouponId, which will be discounted:

UPDATE Customers SET DiscountId = 'cup_123456' WHERE Id = 'cus_85PEPye2wfN4u4'

Delete

To Delete a Customer, specify the Customer Id and run an Delete statement.

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	False		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.
DiscountId	String	False	CustomerDiscounts.CouponId	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		If 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	False		The shipping information associated with the customer.
SourcesdataAggregate	String	False		The payment sources of the customer, if any.
SubscriptionsDataAggregate	String	False		The current subscriptions of the customer, if any.
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.
TaxAggregate	String	False		Tax details for the customer.
TaxIdsAggregate	String	False		The customer's tax IDs.

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.

InvoiceItems

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

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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, and Customer support the following operator: =.

The provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-an All InvoiceLineItems:

SELECT * FROM InvoiceItems

-an InvoiceLineItems by specifying its Id:

SELECT * FROM InvoiceItems WHERE Id = 'or_12345678'

-InvoiceLineItems for a given Customer:

SELECT * FROM InvoiceItems WHERE Customer = 'cus_12345678'

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	Three-letter ISO currency code, in lowercase. Must be a supported currency.
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. 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
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 will use 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, Closed, Date, DueDate, and Subscription support the following operators: <,>>=,<,<=, =.

The provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-an All Invoices:

SELECT * FROM Invoices

-an Invoices by specifying its Id:

SELECT * FROM Invoices WHERE Id = 'or_12345678'

-Invoices for a given Customer:

SELECT * FROM Invoices WHERE CustomerId = 'cus_12345678'

-Invoices by Closed :

SELECT * FROM Invoices WHERE Closed = True

-Invoices by Subscription :

SELECT * FROM Invoices WHERE Subscription='sub_12345678'

Insert

-To Create a new Invoice, CustomerId,CollectionMethod,DaysUntilDue and PendingInvoiceItemsBehavior is required: CustomFieldsAggregate is an aggregate column. See the example below on how to insert into this column.

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

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 who will be billed.
AccountCountry	String	False		The country of the business associated with this invoice, most often the business creating the invoice.
AccountName	String	False		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	False		ID of the Connect Application that created the invoice.
ApplicationFeeAmount	Int	False		The fee in cents that will be 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	False		The status of the most recent automated tax calculation for this invoice.
BillingReason	String	False		Indicates the reason why the invoice was created.
CollectionMethod	String	True		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.
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	True		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 will be 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 will be 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 will be 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	False		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	False		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	False		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	False		The PaymentIntent associated with this invoice.
PaymentMethodOptions	String	False		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	False		Total amount of all post-payment credit notes issued for this invoice.
PrePaymentCreditNotesAmount	Int	False		Total amount of all pre-payment credit notes issued for this invoice.
Quote	String	False		The quote 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	False		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	True		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	False		ID of the test clock this invoice item belongs to.
Total	Int	True		Total after discounts and taxes.
TotalDiscountAmounts	String	False		The aggregate amounts calculated per discount across all line items.
TotalTaxAmounts	String	False		The aggregate amounts calculated per tax rate for all line items.
TransferDataAmount	Int	False		The amount in paise 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	False		Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted.
Customer	String	False		The customers id.
CustomerAddress	String	True		The customers address.
CustomerEmail	String	True		The customers email.
CustomerName	String	True		The customers name.
CustomerPhone	String	True		The customers phone number.
CustomerShipping	String	True		The customers shipping information.
CustomerTaxExempt	String	True		The customers tax exempt status.
CustomerTaxIds	String	True		The customers tax IDs.

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

PaymentLinks

Create, update, and query the PaymentLinks in Stripe.

Table Specific Information

Select

The Sync App will use 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: =.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve the PaymentLinks:

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 (LineItems) VALUES (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\"}')

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\"}' 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.
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.
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.
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.
PhonstringberCollectionEnabled	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.
ShippingOptionsShippingRate	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.
TransferData	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.
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.

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.

PaymentMethods

Create, update and query the available PaymentMethods in Stripe.

Table Specific Information

Select

The Sync App will use 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: =.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve the PaymentMethods:

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).
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.
AcssDebitBankName	String	False		Bank name for the payment method type acss_debit.
AcssDebitInstitutionNumber	String	False		Institution number of the customer bank.
AcssDebitTransitNumber	String	False		Transit number of the customer bank.
AcssDebitFingerprint	String	True		Uniquely identifies this particular bank account for the payment method type acss_debit.
AcssDebitLast4	String	True		Last four digits of the bank account number for the payment method type acss_debit.
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.
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.
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.
P24Bank	String	False		The customer bank. P24 stands for Przelewy24 is a bank redirect payment method used in Poland.
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	True		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.
UsBankAccountRoutingNumber	String	False		Routing number of the bank account.
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.
MetadataOrderId	String	True		MetaData order Id.
Object	String	True		String representing the object type. Objects of the same type share the same value.
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.

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).
AuBecsDebitBsbNumber	String	Bank-State-Branch number of the bank account.
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 will use 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, ArrivalDate, Created, Destination, and Status support the following operators: <,>>=,<,<=,=.

The provider supports ArrivalDate, Created, Destination and Status to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True.

Selecting payouts that have the given status:

SELECT * FROM Payouts WHERE status = 'paid'

If SupportEnhancedSQL property is set to False, you still can retrieve a payout by specifying its Id:

SELECT * FROM Payouts WHERE Id = 'tr_10340J2eZvKYlo2Cg42HilbB'

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.
Livemode	String	True		Flag indicating whether the object exists in live mode or test mode.
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	False		Returns true if the payout was created by an automated payout schedule, and false if it was requested manually.
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.
OriginalPayout	String	False		If the payout reverses another, this is the ID of the original payout.
ReversedBy	String	False		If the payout was reversed, this is the ID of the payout that reverses this 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
AccountId	String	The Id of the connected account to get payouts for

Plans

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

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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, Created, and Product support the following operators: <,>>=,<,<=,=.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-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

Id, Name, Amount, Currency and Interval columns are required to create a new plan .

INSERT INTO Plans (Id,Name,Currency,Interval,IntervalCount,TrialPeriodDays,Amount) VALUES('123-a8z057u','Platinium Plan','usd','month',10,10,1)

Update

To update a plan, specify Id column.

UPDATE Plans SET Name = 'Test Plan',TrialPeriodDays=365,StatementDescriptor='RunClub Silver Plan' WHERE Id = '123easdas'

Delete

To delete a plan specify the Id of the plan.

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	Int	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	False		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.
BillingScheme	String	False		Describes how to compute the price per period. Either per_unit or 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.
Product	String	False		The product whose pricing this plan determines.
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.
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.
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.

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 will use 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, Created, and Product support the following operators: <,>>=,<=,=.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-a 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

Currency, UnitAmount are required to create a price.

INSERT INTO Prices (Currency, Product, UnitAmount, RecurringAggregate, TiersAggregate) VALUES (usd, 'prod_CwgQxpzDYxStuZ', 10, '{\"interval\":\"month\", \"interval_count\": \"3\"}', '[{\"up_to\": \"1\", \"unit_amount_decimal\": \"1000\", \"flat_amount_decimal\": \"1000\" },{\"up_to\": \"inf\", \"unit_amount_decimal\": \"1500\", \"flat_amount_decimal\": \"1500\"}]')

Update

To update a price, specify Id column.

UPDATE Plans SET Active = false WHERE Id = 'price_1HeiRmATXQzBWNrlQOSoEytH'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		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..
LiveMode	String	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
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	Products.Id	A brief description of the plan, hidden from customers.
Product	String	False		The ID of the product this price is associated with.
RecurringAggregate	String	False		The recurring components of a price such as interval and usage_type.
Type	String	False		Value is either 'one_time' or 'recurring' depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
TiersAggregate	String	False		Array of elements representing a pricing tier.
TiersMode	String	False		Defines if the tiering price should be graduated or volume based.
TransformQuantity	String	False		Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers.
UnitAmount	Double	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	False		String representing the object's type. Objects of the same type share the same value.
Livemode	Boolean	False		Tells if the dispute is in livemode.
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.

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.

Refunds

Create and query the available refunds in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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, and Created support the following operators: <,>>=,<,<=,=.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-a Refund by specifying its Id:

SELECT * FROM Refunds WHERE Id = 're_19keFRGOsuAdslZgO7zSbS2j'

-Refunds for the charge specified by Charge Id:

SELECT * FROM Refunds WHERE Charge = 'MyChargeId'

Insert

To insert a refund, provide a Charge Id.

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

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	False		The balance transaction that describes the impact on your account balance.
Created	Datetime	True		The refund datetime.
Currency	String	False		Three-letter ISO code representing the currency.
Reason	String	False		The reason for the refund.
ReceiptNumber	String	False		This is the transaction number that appears on email receipts sent for this refund.
MetadataAggregate	String	False		The refund metadata object.
Description	String	False		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	False		String representing the object's type. Objects of the same type share the same value.
FailureBalanceTransaction	String	False		If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
FailureReason	String	False		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	False		This property will describe what the refund needs in order to continue processing.
SourceTransferReversal	String	False		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	False		If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.

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.

SubscriptionDiscounts

Get and delete the available discount of a Subscription.

Table Specific Information

Select

Server-Side Query Support

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

SubscriptionId supports the following operator: =.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-Subscriptions Discount list:

SELECT * FROM SubscriptionDiscounts

Insert

Insert is not supported.

Update

Update is not supported.

Delete

To delete a discount for a Subscription, specify the SubscriptionId:

DELETE FROM SubscriptionDiscounts WHERE SubscriptionId = 'sub_155dae52s'

Columns


Name	Type	ReadOnly	References	Description
SubscriptionId [KEY]	String	False		The id of the subscription.
CouponId	String	False		The id of the coupon.
CreatedAt	Datetime	False		The creation date.
Start	Datetime	False		If the subscription has a trial, the beginning of that trial.
End	Datetime	False		If the subscription has a trial, the end of that trial.
Currency	String	False		If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
Name	String	False		Name of the coupon displayed to customers on for instance invoices or receipts.
Duration	String	False		One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
DurationInMonths	Integer	False		the number of months the coupon applies.
AmountOff	Integer	False		Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
PercentOff	Integer	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 percent_off of 50 will make a $100 invoice $50 instead.
Valid	Boolean	False		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.
TimesRedeemed	Integer	False		Number of times this coupon has been applied to a customer.
Object	String	False		String representing the object's type. Objects of the same type share the same value.
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.
Invoice	String	False		The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
InvoiceItem	String	False		The invoice line item id that the discount's coupon was applied to if it was applied directly to a invoice line item.
PromotionCode	String	False		The promotion code applied to create this discount.The promotion code applied to create this discount.
MetadataAggregate	String	False		Set of key-value pairs that you can attach to 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 Subscription discounts for.

SubscriptionItems

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

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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 SubscriptionId support the following operator: =.

To query SubscriptionItems table, the Id of the subscription (SubscriptionId) whose items will be retrieved is required:

SELECT * FROM Subscriptions WHERE SubscriptionId = 'sub_A9WZGVTbvgBJ4t'

In addition to SubscriptionId, provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve a SubscriptionItem by specifying its Id:

SELECT * FROM SubscriptionItems WHERE Id = 'sit_A9WZGVTbvgBJ4t'

Insert

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

INSERT INTO SubscriptionItems (SubscriptionId,PlanId,IsProrate,ProrationDate,Quantity) VALUES ('sub_A9YR1bLGFLQ5vV','gold $',true,2014-12-12,10)

Update

To update a subscription item, specify the Id column.

UPDATE SubscriptionItems SET PlanId = 'sub_A8TYczJcECr7Ph', IsProrate = false, ProrationDate = '2014-12-12', Quantity = 12 WHERE Id ='set_g155'

Delete

To delete a subscription item specify the Id of the item.

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.
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.
Object	String	False		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.

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.
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 will use 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, CreatedAt, PlanId, and Status support the following operators: <,>>=,<,<=,=.

The provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-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'

Insert

CustomerId and PlanId columns are required to create a new subscription .

INSERT INTO Subscriptions (CustomerId,PlanId,ApplicationFeePercent,Quantity,TaxPercent,TrialEnd) VALUES ('cus_A8PXYRQoPlrgpR','123-z72a0xda9',1,100,10,'2017-12-12')

To apply a discount to a new subscription, set the CouponId field:

INSERT INTO Subscriptions (CustomerId,PlanId,ApplicationFeePercent,Quantity,TaxPercent,TrialEnd,CouponId) VALUES ('cus_A8PXYRQoPlrgpR','123-z72a0xda9',1,100,10,'2017-12-12','cup_123456')

Update

To update a subscription, specify Id column.

UPDATE Subscriptions SET ApplicationFeePercent=0, Quantity=500, TaxPercent=10, IsProrate = true WHERE Id = 'sub_A9WZGVTbvgBJ4t'

To apply a discount to an existing subscription, set the CouponId field:

UPDATE Subscriptions SET CouponId = 'cup_123456' WHERE Id = 'sub_A9WZGVTbvgBJ4t'

Delete

To delete a subscription specify the Id of the subscription.

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.
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	True		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	SubscriptionDiscounts.CouponId	The id of the discount.
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	False		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.
Start	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.
TaxPercent	Decimal	False		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	True		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	False		The ID of the most recent invoice this subscription has generated.
PendingSetupIntent	String	False		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	False		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.
AutomaticTaxStatus	String	False		The status of the most recent automated tax calculation for this subscription.
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.
DaysUntilDue	Integer	False		Number of days a customer has to pay invoices generated by this subscription. This value will be 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	Integer	False		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
NextPendingInvoiceItemInvoice	Datetime	False		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	False		If specified, payment collection for this subscription will be paused.
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.
Schedule	String	False		The schedule attached to the subscription
TestClock	String	False		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.

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.
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.
AccountId	String	The Id of the connected account to get subscriptions 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 will use 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 TransferReversals table, the Id of the transfer whose reversals will be retrieved is required:

SELECT * FROM  TransferReversals WHERE Transfer = 'tr_12345678'

In addition to Transfer, the Sync App supports all columns to be used as criteria in the WHERE clause of a SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve a Reversal by specifying its Id:

SELECT * FROM  TransferReversals WHERE Id = 'tr_12345678'

Insert

The Transfer column is required to insert to this table:

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

Update

Specify both Id and Transfer to update records in this table:

UPDATE TransferReversals SET Description = 'My 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	True		The Id of the transfer that was reversed.
Amount	Integer	False		A positive integer in cents representing how much of this transfer to reverse.
Description	String	False		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.
RefundApplicationFee	Boolean	False		Boolean indicating whether the application fee should be refunded when reversing this transfer.
Currency	String	False		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	False		String representing the object's type. Objects of the same type share the same value.
BalanceTransaction	String	False		Balance transaction that describes the impact on your account balance.
DestinationPaymentRefund	String	False		Linked payment refund for the transfer reversal.
Created	Datetime	False		Time at which the object was created. Measured in seconds since the Unix epoch.
SourceRefund	String	False		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
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 will use 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 Destination support the following operator: =.

The provider supports all columns to be used as criteria in the WHERE clause of a SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you can still retrieve:

-a Transfer by specifying its Id:

SELECT * FROM Transfers WHERE Id = 'tr_12345678'

-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) VALUES (1000, 'USD', 'acct_19abC2DFGl5DVRzj')

Update

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

UPDATE Transfers SET Description = 'New desc' 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	False		Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
ApplicationFee	String	False		The application fee.
BalanceTransaction	String	False		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	False		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.Can be card, bank_account, or stripe_account.
MetadataAggregate	String	False		The transfer metadata object.
Object	String	False		String representing the object's type. Objects of the same type share the same value.
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.
ReversalsAggregate	Boolean	False		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.

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Stripe Connector for CData Sync Views


Name	Description
AvailableBalance	Query the Available Balance in Stripe.
BalanceChangeFromActivitySummaryReport	Query the Balance change from activity summary report in Stripe.
BalanceSummaryReportInternal	Query the Balance Summary report in Stripe.
BalanceTransactions	Query Balance History in Stripe.
CountrySpecs	Query the available Country Specs in Stripe.
Disputes	Query the available Disputes in Stripe.
EndingBalanceReconciliationSummaryReport	Query the Ending balance reconciliation summary report in Stripe.
Events	Query the available events in Stripe.
InvoiceLineItems	Query the available invoices line items in Stripe.
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.
Orders	Query the available orders in Stripe.
PaymentIntent	A PaymentIntent guides you through the process of collecting a payment from your customer.
PaymentLinkLineItems	Query the available PaymentLink line items in Stripe.
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.
Products	Query the available products in Stripe.
Reports	To Create and Query the Report Run object, which represents an instance of a report type generated with specific run parameters.
ShippingRates	Query the available Shipping rates in Stripe.
Skus	Query the available SKUs in Stripe.

AvailableBalance

Query the Available Balance in Stripe.

Table Specific Information

Select

The following query retrieves all data from AvailableBalance view (the provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True):

SELECT * FROM AvailableBalance

Columns


Name	Type	References	Description
Currency	String		The currency of the available balance.
Amount	Integer		The available amount.
SourceTypesCard	Integer		The source cards.
SourceTypesBankAccount	Integer		Amount for bank account.
SourceTypesFpx	Integer		Amount for FPX.

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

It is used to query the Balance change from activity summary report in Stripe.

Note: It requires a live-mode API key which we can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Creating the Report

To create a report we need to pass some required parameters.

ParametersIntervalStart
ParametersIntervalEnd

To create a report we can also pass some optional parameters.

ParametersColumns
ParametersCurrency

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

Select

To query the report we can try the below queries.

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 will show multiple reports
SELECT * FROM BalanceChangeFromActivitySummaryReport 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.

BalanceSummaryReportInternal

Query the Balance Summary report in Stripe.

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	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 will use 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, Created, Currency, Source, and Type support the following operators: >, >=, <, <=, =.

The following query gets all records from BalanceTransactions view (the provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True):

SELECT * FROM BalanceTransactions

You can also filter balance transactions that were paid out on the specified payout ID.

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

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 will use 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: =.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve a Country Spec by specifying its Id:

SELECT * FROM CountrySpecs WHERE Id = 'MyCountrySpecsId'

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

Disputes

Query the available Disputes in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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 Created support the following operators: <,>>=,<,<=,=.

The provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-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

Update is not supported.

Delete

Delete is not supported.

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the dispute.
Currency	String		Three-letter ISO currency code representing the currency of the amount that was disputed.
EvidenceAccessActivityLog	String		Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product.
EvidenceBillingAddress	String		The billing address provided by the customer.
EvidenceCancellationPolicy	String		Your subscription cancellation policy, as shown to the customer.
EvidenceCancellationPolicyDisclosure	String		An explanation of how and when the customer was shown your refund policy prior to purchase.
EvidenceCancellationRebuttal	String		A justification for why the customer's subscription was not canceled.
EvidenceCustomerCommunication	String		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		The email address of the customer.
EvidenceCustomerName	String		The name of the customer.
EvidenceCustomerPurchaseIp	String		The IP address that the customer used when making the purchase.
EvidenceCustomerSignature	String		The (ID of a file upload) A relevant document or contract showing the customer's signature.
EvidenceDuplicateChargeDocumentation	String		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		The explanation of the difference between the disputed charge and the prior charge that appears to be a duplicate.
EvidenceDuplicateChargeId	String		The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.
EvidenceProductDescription	String		The description of the product or service which was sold.
EvidenceReceipt	String		The (ID of a file upload) Any receipt or message sent to the customer notifying them of the charge.
EvidenceRefundPolicy	String		The (ID of a file upload) Your refund policy, as shown to the customer.
EvidenceRefundPolicyDisclosure	String		The documentation demonstrating that the customer was shown your refund policy prior to purchase.
EvidenceRefundRefusalExplanation	String		The justification for why the customer is not entitled to a refund.
EvidenceServiceDate	String		The date on which the customer received or began receiving the purchased service, in a clear human-readable format.
EvidenceServiceDocumentation	String		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		The address to which a physical product was shipped. You should try to include as much complete address information as possible.
EvidenceShippingCarrier	String		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		The date on which a physical product began its route to the shipping address, in a clear human-readable format.
EvidenceShippingDocumentation	String		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		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		The (ID of a file upload) Any additional evidence or statements.
EvidenceUncategorizedText	String		Any additional evidence or statements.
EvidenceDetailsDueBy	Datetime		Date by which evidence must be submitted in order to successfully challenge dispute.
EvidenceDetailsHasEvidence	Boolean		Whether or not evidence has been saved for this dispute.
EvidenceDetailsPastDue	Boolean		Whether or not the last evidence submission was submitted past.
EvidenceDetailsSubmissionCount	Integer		The number of times the evidence has been submitted.
Amount	Integer		The disputed amount.
BalanceTransactionsAggregate	String		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		The Id of the charge that was disputed.
Created	Datetime		The Date dispute was opened.
IsChargeRefundable	Boolean		If true, it is still possible to refund the disputed payment.
Livemode	Boolean		Tells if the dispute is in livemode.
Reason	String		The reason given by cardholder for dispute.
Status	String		The current status of dispute.
MetadataAggregate	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.
Transaction	String		The transaction being disputed.
Object	String		String representing the object's type. Objects of the same type share the same value.
PaymentIntent	String		ID of the PaymentIntent that was disputed.

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.

EndingBalanceReconciliationSummaryReport

Query the Ending balance reconciliation summary report in Stripe.

Table Specific Information

It is used to query the Ending balance reconciliation summary report in Stripe.

Note: It requires a live-mode API key which we can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Creating the Report

To create a report we need to pass some required parameters.

ParametersIntervalEnd

To create a report we can also pass some optional parameters.

ParametersColumns
ParametersCurrency

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

Select

To query the report we can try the below queries.

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	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 will use 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, Created, and Type support the following operators: <,>>=,<,<=,=.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-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	String		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.
Request	String		The Id of the API request that caused the event.
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.

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.

InvoiceLineItems

Query the available invoices line items in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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: =.

The provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-an InvoiceLineItems by specifying its InvoiceId:

SELECT * FROM InvoiceLineItems WHERE InvoiceId = 'in_123456'

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.

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

ItemizedBalanceChangeFromActivityReport

Query the Itemized balance change from Activity report in Stripe.

Table Specific Information

It is used to query the Itemized balance change from Activity report in Stripe.

Note: It requires a live-mode API key which we can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Creating the Report

To create a report we need to pass some required parameters.

ParametersIntervalStart
ParametersIntervalEnd

To create a report we can also pass some optional parameters.

ParametersColumns
ParametersCurrency
ParametersTimezone
ParametersReportingCategory

// This will first create the new Report and display that report. 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

To query the report we can try the below queries.

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_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	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

It is used to query the Itemized ending balance change from activity report in Stripe.

Note: It requires a live-mode API key which we can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Creating the Report

To create a report we need to pass some required parameters.

ParametersIntervalEnd

To create a report we can also pass some optional parameters.

ParametersColumns
ParametersCurrency
ParametersTimezone
ParametersReportingCategory

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

Select

To query the report we can try the below queries.

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

It is used to query the Itemized payout reconciliation report in Stripe.

Note: It requires a live-mode API key which we can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Creating the Report

To create a report we need to pass some required parameters.

ParametersIntervalStart
ParametersIntervalEnd

To create a report we can also pass some optional parameters.

ParametersColumns
ParametersCurrency
ParametersTimezone
ParametersReportingCategory

// This will first create the new Report and display that report. 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

To query the report we can try the below queries.

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

It is used to query the Itemized payouts report in Stripe.

Note: It requires a live-mode API key which we can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Creating the Report

To create a report we need to pass some required parameters.

ParametersIntervalStart
ParametersIntervalEnd

To create a report we can also pass some optional parameters.

ParametersColumns
ParametersCurrency
ParametersTimezone
ParametersReportingCategory

// This will first create the new Report and display that report. 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

To query the report we can try the below queries.

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

It is used to query the Itemized reconciliation for a single payout report in Stripe.

Note: It requires a live-mode API key which we can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Creating the Report

To create a report we need to pass some required parameters.

ParametersPayout

To create a report we can also pass some optional parameters.

ParametersColumns
ParametersTimezone
ParametersReportingCategory

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

Select

To query the report we can try the below queries.

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

Orders

Query the available orders in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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, Created, Customer, and Status support the following operators: IN,<,>>=,<,<=,=.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-an Order by specifying its Id:

SELECT * FROM Orders WHERE Id = 'or_12345678'

-an Order by specifying its Ids:

SELECT * FROM Orders WHERE Id IN ('or_12345678','or_123456789','or_123456788')

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

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

-Orders for a given Customer:

SELECT * FROM Orders WHERE Customer = 'cus_12345678'

-Orders with a specific Status:

SELECT * FROM Orders WHERE Status = 'paid'

Columns


Name	Type	References	Description
Id [KEY]	String		ID of card.
Amount	Integer		A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a 0-decimal currency) representing the total amount for the order.
Application	String		ID of the Connect Application that created the order.
ApplicationFee	Integer		Integer.
Created	Datetime		Time of creation.
Charge	String		The ID of the payment used to pay for the order. Present if the order status is paid, fulfilled, or refunded.
Currency	String		3-letter ISO code representing the currency in which the order was made.
Customer	String		The customer used for the order.
Email	String		The email address of the customer placing the order.
ExternalCouponCode	String		The external coupon code.
ItemsAggregate	String		List of items constituting the order.
SelectedShippingMethod	String		The shipping method that is currencly selected for this order, if any.
Shipping	String		The shipping address for the order. Present if the order is for goods to be shipped.
ShippingMethodsAggregate	String		A list of supported shipping methods for this order.
Status	String		Current order status.
StatusTransitions	String		The datetimes at which the order status was updated.
Updated	Datetime		The time when the order is last updated.

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

PaymentIntent

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

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
Amount	Integer		Amount intended to be collected by this PaymentIntent.
AmountDetailsTip	String		Amount Details Tip
AmountCapturable	Integer		Amount that can be captured from this PaymentIntent.
AmountReceived	Integer		Amount that was collected by this PaymentIntent.
ApplicationFeeAmount	Integer		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		Automatically calculates compatible payment methods
Charges	String		Charges
CanceledAt	Datetime		Populated when status is canceled, this is the time at which the PaymentIntent was canceled.
CancellationReason	String		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		Controls when the funds will be captured from the customers account.
ClientSecret	String		The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
ConfirmationMethod	String		Possible enum values-automatic, manual
Created	Integer		Time at which the object was created. Measured in seconds since the Unix epoch.
Currency	String		Three-letter ISO currency code, in lowercase.
Application	String		ID of the Connect application that created the PaymentIntent.
Customer	String		ID of the Customer this PaymentIntent belongs to, if one exists.
LatestCharge	String		The latest charge created by this payment intent.
PaymentMethod	String		ID of the payment method used in this PaymentIntent.
TransferDataDestination	String		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		The account (if any) for which the funds of the PaymentIntent are intended.
Invoice	String		ID of the invoice that created this PaymentIntent, if it exists.
Review	String		ID of the review associated with this PaymentIntent, if any.
Description	String		An arbitrary string attached to the object. Often useful for displaying to users.
LastPaymentErrorCharge	String		For card errors, the ID of the failed charge.
LastPaymentErrorCode	String		For some errors that could be handled programmatically, a short string indicating the error code reported.
LastPaymentErrorDeclineCode	String		For some errors that could be handled programmatically, a short string indicating the error code reported.
LastPaymentErrorDocURL	String		A URL to more information about the error code reported.
LastPaymentErrorMessage	String		A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
LastPaymentErrorParam	String		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		The PaymentMethod object for errors returned on a request involving a PaymentMethod.
LastPaymentErrorPaymentMethodType	String		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		The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
LiveMode	Boolean		Has the value true if the object exists in live mode or the value true if the object exists in test mode.
NextAction	String		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		String representing the objects type. Objects of the same type share the same value.
PaymentMethodOptions	String		Payment-method-specific configuration for this PaymentIntent.
PaymentMethodTypes	String		The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
ProcessingCard	String		If the PaymentIntents payment_method_types includes card, this hash contains the details on the processing state of the payment.
ProcessingType	String		Type of the payment method for which payment is in processing state, one of card.
ReceiptEmail	String		Set of key-value pairs that you can attach to an object.
MetadataAggregate	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.
SetupFutureUsage	String		Indicates that you intend to make future payments with this PaymentIntents payment method.
ShippingAddressCity	String		City, district, suburb, town, or village..
ShippingAddressCountry	String		Two-letter country code
ShippingAddressline1	String		Address line 1
ShippingAddressline2	String		Address line 2
ShippingAddressPostalCode	String		ZIP or postal code.
ShippingAddressState	String		State, county, province, or region.
ShippingCarrier	String		The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
ShippingName	String		Recipient name.
ShippingPhone	String		Recipient phone (including extension).
ShippingTrackingNumber	String		The tracking number for a physical product, obtained from the delivery service.
StatementDescriptor	String		For non-card charges, you can use this value as the complete description that appears on your customers statements.
StatementDescriptorSuffix	String		Provides information about a card payment that customers see on their statements.
Status	String		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		Amount intended to be collected by this PaymentIntent.
TransferGroup	String		A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

PaymentLinkLineItems

Query the available PaymentLink line items in Stripe.

Table Specific Information

Select

The Sync App will use 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: =.

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	Timestamp		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	Integer		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	Integer		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	Integer		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.

PayoutsReconciliationSummaryForASinglePayoutReport

Payouts reconciliation summary for a single payout in Stripe.

Table Specific Information

It is used to query the Payouts reconciliation summary for a single payout in Stripe.

Note: It requires a live-mode API key which we can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Creating the Report

To create a report we need to pass some required parameters.

ParametersPayout

To create a report we can also pass some optional parameters.

ParametersColumns

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

Select

To query the report we can try the below queries.

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

It is used to query the Payouts reconciliation summary report in Stripe.

Note: It requires a live-mode API key which we can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Creating the Report

To create a report we need to pass some required parameters.

ParametersIntervalStart
ParametersIntervalEnd

To create a report we can also pass some optional parameters.

ParametersColumns
ParametersCurrency

// This will first create the new Report and display that report. 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

To query the report we can try the below queries.

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

It is used to query the Payouts summary report in Stripe.

Note: It requires a live-mode API key which we can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Creating the Report

To create a report we need to pass some required parameters.

ParametersIntervalStart
ParametersIntervalEnd

To create a report we can also pass some optional parameters.

ParametersColumns
ParametersCurrency

// This will first create the new Report and display that report. 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

To query the report we can try the below queries.

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

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True.Otherwise Stripe does not allow any columns to be used in the WHERE clause in queries to this view.

SELECT * FROM PendingBalance

Columns


Name	Type	References	Description
Currency	String		The currency of the balance.
Amount	Integer		The pending amount.
SourceTypesCardAggregate	String		The source cards.
SourceTypesCard	Integer		The source cards.
SourceTypesBankAccount	Integer		The source Bank Account.
SourceTypesFPX	Integer		The source FPX.

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.

Products

Query the available products in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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, Created, Shippable, Type, and Url support the following operators: IN,<,>>=,<,<=,=.

The following query retrieves all products:

SELECT * FROM Products

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-a Product by specifying its Id:

SELECT * FROM Products WHERE Id = '12345678'

-a Product by specifying its 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'

Columns


Name	Type	References	Description
Id [KEY]	String		ID of product.
Active	Boolean		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.
AttributesAggregate	String		A list of up to 5 attributes that each SKU can provide value.
Caption	String		A short one-line description of the product, meant to be displayable to the customer.
Created	Datetime		The time when product is created.
Description	String		The product's description, meant to be displayable to the customer.
Name	String		The product's name, meant to be displayable to the customer.maximum character length limit of 250
PackageDimensionsHeight	Double		The height dimension of this product for shipping purposes.
PackageDimensionsLength	Double		The length dimension of this product for shipping purposes.
PackageDimensionsWeight	Double		The weight dimension of this product for shipping purposes.
PackageDimensionsWidth	Double		The width dimension of this product for shipping purposes.
Shippable	Boolean		Whether this product is a shipped good.
StatementDescriptor	String		Extra information about a charge for the credit card statement of the customer.
Updated	Datetime		The last updated time.
Type	String		The type of the product..
Url	String		The URL of a publicly-accessible webpage for this product.
TaxCode	String		A tax code ID.
Livemode	Boolean		Tells if the dispute is in livemode.
MetadataAggregate	String		Set of key-value pairs
Object	String		String representing the object's type. Objects of the same type share the same value.
UnitLabel	String		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		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.

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

Reports can be used to query all the reports or a specific report.

Note: It requires a live-mode API key which you can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Select

Server-Side Query Support

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

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.
ResultLinksData	String		Details about each 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.
ResultLinksDataId	String		Unique identifier for the object.
ResultLinksDataObject	String		String representing the object's type. Objects of the same type share the same value.
ResultLinksDataCreated	Timestamp		Time at which the object was created. Measured in seconds since the Unix epoch.
ResultLinksDataExpired	Boolean		Whether this link is already expired.
ResultLinksDataExpiresAt	Timestamp		Time at which the link expires.
ResultLinksDataFile	String		The file object this link points to.
ResultLinksDataLivemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
ResultLinksDataMetaDataAggregate	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.
ResultLinksDataUrl	String		The URL where this list can be accessed.

ShippingRates

Query the available Shipping rates in Stripe.

Table Specific Information

Select

The Sync App will use 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 operator: =.
AccountId supports the following operator: =.

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

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the Shipping Rates.
Active	Boolean		Whether the shipping rate can be used for new purchases. Its default value is true.
Created	Timestamp		Time at which the object was created. Measured in seconds since the Unix epoch.
DeliveryEstimate	String		The estimated range for how long shipping will take, meant to be displayable to the customer.
DisplayName	String		The name of the shipping rate, meant to be displayable to the customer.
FixedAmountAmount	Integer		A non-negative integer in cents representing how much to charge.
FixedAmountCurrency	String		Three-letter ISO currency code, in lowercase. Must be a supported currency.
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		The Object type.
TaxBehavior	String		Whether the rate is considered inclusive of taxes or exclusive of taxes.
TaxCode	String		Tax code Id.
Type	String		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.

Skus

Query the available SKUs in Stripe.

Table Specific Information

Select

Server-Side Query Support

The Sync App will use 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, AttributesAggregate, and ProductId support the following operators: IN,=.

The provider supports all columns to be used as criteria in the WHERE clause of SELECT statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:

-a SKU by specifying its Id:

SELECT * FROM Skus WHERE Id = '12345678'

-a SKU by specifying its Ids:

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

-Skus of a Product:

SELECT * FROM Skus WHERE Product = 'pd_12345678'

-Skus that are in stock:

SELECT * FROM Skus WHERE InStock = 'true'

-Active Skus:

SELECT * FROM Skus WHERE Active = 'true'

Columns


Name	Type	References	Description
Id [KEY]	String		Id of SKU.
Active	Boolean		Whether or not the SKU is available for purchase.
AttributesAggregate	String		A dictionary of attributes and values for the attributes defined by the product.
Created	Datetime		The time when SKU is created.
Currency	String		3-letter ISO code for currency.
Images	String		The URL of an image for this SKU, meant to be displayable to the customer.
InventoryQuantity	Double		Description of the SKU's inventory.
InventoryType	String		Description of the SKU's inventory.
InventoryValue	Double		Description of the SKU's inventory.
PackageDimensionsHeight	Double		The height dimension of this Sku for shipping purposes.
PackageDimensionsLength	Double		The length dimension of this Sku for shipping purposes.
PackageDimensionsWeight	Double		The weight dimension of this Sku for shipping purposes.
PackageDimensionsWidth	Double		The width dimension of this Sku for shipping purposes.
Price	Integer		The cost of the item as a positive integer in the smallest currency unit.
ProductId	String		The Id of the product this SKU is associated with. The product must be currently active.
Updated	Datetime		The last updated time.
Metadata	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.
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 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
InStock	String		if the SKUs is either in stock or out of stock
AccountId	String		The Id of the connected account to get SKUs 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	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken	The access token for connecting using OAuth.

SSL

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

Firewall

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

Property	Description
LogModules	Core modules to be included in the log file.

Schema

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	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	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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

Auto: Lets the driver decide automatically based on the other connection properties you have set.
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	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken	The access token for connecting using OAuth.

OAuthClientId

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

SSL

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

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

SSLServerCert

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	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that 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.


Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Stripe and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your 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

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Proxy

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

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

ProxyAutoDetect

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

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 a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

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.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

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

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

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

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:


AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is 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 ProxyServer .

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, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logging

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

Property	Description
LogModules	Core modules to be included in the log file.

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Schema

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

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) 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" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that 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	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

AccountId

The ID of the Account that you want to use.

Remarks

By default the provider will use the authenticated account.

LiveAPIKey

LiveAPIKey is required to generate and view the Reports.

Remarks

LiveAPIKey is required to generate and view the Reports.

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

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

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

Each root element defines the name of a view.
Each root element contains a child element, called query, which contains the custom 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)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

Stripe Connector for CData Sync

Stripe Connector for CData Sync

Overview

Establishing a Connection

Connecting to Stripe

Authenticating 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

Columns

Pseudo-Columns

Cards

Table Specific Information

Select

Server-Side Query Support

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

Coupons

Table Specific Information