Matillion ETL Data Model for Stripe
Version - 21.0.8137.0

Note: Data models are true for the latest version of Matillion ETL. If you are on an older version or using a component from an old job, your experience may differ.



Connection String OptionsBack To Top

  1. AuthScheme
  2. InitiateOAuth
  3. OAuthClientId
  4. OAuthClientSecret
  5. OAuthAccessToken
  6. OAuthSettingsLocation
  7. CallbackURL
  8. OAuthVerifier
  9. OAuthRefreshToken
  10. OAuthExpiresIn
  11. OAuthTokenTimestamp
  12. SSLServerCert
  13. FirewallType
  14. FirewallServer
  15. FirewallPort
  16. FirewallUser
  17. FirewallPassword
  18. ProxyAutoDetect
  19. ProxyServer
  20. ProxyPort
  21. ProxyAuthScheme
  22. ProxyUser
  23. ProxyPassword
  24. ProxySSLType
  25. ProxyExceptions
  26. Logfile
  27. Verbosity
  28. LogModules
  29. MaxLogFileSize
  30. MaxLogFileCount
  31. Location
  32. BrowsableSchemas
  33. Tables
  34. Views
  35. AutoCache
  36. CacheDriver
  37. CacheConnection
  38. CacheLocation
  39. CacheTolerance
  40. Offline
  41. CacheMetadata
  42. AccountId
  43. BatchSize
  44. ConnectionLifeTime
  45. ConnectOnOpen
  46. LiveAPIKey
  47. MaxRows
  48. Other
  49. PoolIdleTimeout
  50. PoolMaxSize
  51. PoolMinSize
  52. PoolWaitTime
  53. PseudoColumns
  54. Readonly
  55. RTK
  56. SupportEnhancedSQL
  57. Timeout
  58. UseConnectionPooling

AuthScheme

Data Type

string

Default Value

"Auto"

Remarks



InitiateOAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.



OAuthClientId

Data Type

string

Default Value

""

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

Data Type

string

Default Value

""

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

Data Type

string

Default Value

""

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.



OAuthSettingsLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\Stripe Data Provider\\OAuthSettings.txt"

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.

Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.

If left unspecified, the default location is "%APPDATA%\\CData\\Stripe Data Provider\\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config



CallbackURL

Data Type

string

Default Value

""

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.



OAuthVerifier

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See Establishing a Connection to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.



OAuthRefreshToken

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.



OAuthExpiresIn

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.



OAuthTokenTimestamp

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.



SSLServerCert

Data Type

string

Default Value

""

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.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

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



FirewallType

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver 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 driver opens a connection to Stripe and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the driver 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 driver 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

Data Type

string

Default Value

""

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 driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.



FirewallPort

Data Type

int

Default Value

0

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

Data Type

string

Default Value

""

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

Data Type

string

Default Value

""

Remarks

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



ProxyAutoDetect

Data Type

bool

Default Value

false

Remarks

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

NOTE: When this property is set to True, the proxy used is determined as follows:

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



ProxyServer

Data Type

string

Default Value

""

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver 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 driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.



ProxyPort

Data Type

int

Default Value

80

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

Data Type

string

Default Value

"BASIC"

Remarks

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

Note that the driver 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:

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



ProxyUser

Data Type

string

Default Value

""

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

Data Type

string

Default Value

""

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 driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.



ProxySSLType

Data Type

string

Default Value

"AUTO"

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:

AUTODefault setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe 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

Data Type

string

Default Value

""

Remarks

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

Note that the driver 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.



Logfile

Data Type

string

Default Value

""

Remarks

Once this property is set, the driver will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.

Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.

If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.

For more control over what is written to the log file, you can adjust the Verbosity property.

Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.

To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.

If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.

Java Logging

Java logging is also supported. To enable Java logging, set Logfile to:

Logfile=JAVALOG://myloggername

As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.

The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.

When Java logging is enabled, the Verbosity will now correspond to specific logging levels.



Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.



LogModules

Data Type

string

Default Value

""

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.



MaxLogFileSize

Data Type

string

Default Value

"100MB"

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.

Adjust the maximum number of logfiles generated with MaxLogFileCount.



MaxLogFileCount

Data Type

int

Default Value

-1

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.

The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Adjust the maximum size of the logfiles generated with MaxLogFileSize.



Location

Data Type

string

Default Value

"%APPDATA%\\CData\\Stripe Data Provider\\Schema"

Remarks

The path to a directory which contains the schema files for the driver (.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:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config



BrowsableSchemas

Data Type

string

Default Value

""

Remarks

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



Tables

Data Type

string

Default Value

""

Remarks

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

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

Data Type

string

Default Value

""

Remarks

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

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.



AutoCache

Data Type

bool

Default Value

false

Remarks

When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice.

Setting the Caching Database

When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

See Also



CacheDriver

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.

Note that you must also add the CacheDriver JAR file to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:

jdbc:stripe:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost:33333;
To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
jdbc:stripe:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost:33333;
SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:stripe:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost:33333;
MySQL

The following is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:stripe:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost:33333;

  
SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:stripe:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost:33333;
Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:stripe:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost:33333;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .
PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:stripe:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost:33333;



CacheConnection

Data Type

string

Default Value

""

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

Derby and Java DB

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory

SQLite

To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:

jdbc:sqlite:dataSource

MySQL

The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
The following are typical connection properties:

SQL Server

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
The following are typical SQL Server connection properties:
Oracle

The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
The following are typical connection properties:
PostgreSQL

The following is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
The following are typical connection properties:



CacheLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\Stripe Data Provider"

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

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

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

See Also



CacheTolerance

Data Type

int

Default Value

600

Remarks

The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.



Offline

Data Type

bool

Default Value

false

Remarks

When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.



CacheMetadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the Stripe catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata



AccountId

Data Type

string

Default Value

""

Remarks

By default the provider will use the authenticated account.



BatchSize

Data Type

int

Default Value

0

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.



ConnectionLifeTime

Data Type

int

Default Value

0

Remarks

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.



ConnectOnOpen

Data Type

bool

Default Value

false

Remarks

When set to true, a connection will be made to Stripe when the connection is opened. This property enables the Test Connection feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to Stripe and nothing from this initial connection is maintained.

Setting this property to false may provide performance improvements (depending upon the number of times a connection is opened).



LiveAPIKey

Data Type

string

Default Value

""

Remarks

LiveAPIKey is required to generate and view the Reports.



MaxRows

Data Type

int

Default Value

-1

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

Data Type

string

Default Value

""

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.

Caching Configuration

CachePartial=TrueCaches only a subset of columns, which you can specify in your query.
QueryPassthrough=TruePasses the specified query to the cache database instead of using the SQL parser of the driver.

Integration and Formatting

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



PoolIdleTimeout

Data Type

int

Default Value

60

Remarks

The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.



PoolMaxSize

Data Type

int

Default Value

100

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.



PoolMinSize

Data Type

int

Default Value

1

Remarks

The minimum number of connections in the pool. The default is 1.



PoolWaitTime

Data Type

int

Default Value

60

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.



PseudoColumns

Data Type

string

Default Value

""

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, "*=*".



Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.



RTK

Data Type

string

Default Value

""

Remarks

The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.



SupportEnhancedSQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL = true, the driver offloads as much of the SELECT statement processing as possible to Stripe and then processes the rest of the query in memory. In this way, the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL = false, the driver limits SQL execution to what is supported by the Stripe API.

Execution of Predicates

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

The driver retrieves all rows necessary to process the aggregation in memory.



Timeout

Data Type

int

Default Value

60

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 driver throws an exception.



UseConnectionPooling

Data Type

bool

Default Value

false

Remarks

This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.





TablesBack To Top

  1. Accounts
  2. BankAccounts
  3. BankAccountTokens
  4. Cards
  5. CardTokens
  6. Charges
  7. Coupons
  8. CustomerDiscounts
  9. Customers
  10. InvoiceLineItems
  11. Invoices
  12. Payouts
  13. Plans
  14. Prices
  15. Refunds
  16. SubscriptionDiscounts
  17. SubscriptionItems
  18. Subscriptions
  19. TransferReversals
  20. Transfers

Accounts

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

Table Specific Information
Select
Server-Side Query Support

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

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 retreive an Account by specifying its Id:

SELECT * FROM Accounts WHERE Id='MyId'



Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique identifier for the account.

BusinessName String False

The publicly visible name of the business.

BusinessPrimaryColor String False

A CSS hex color value representing the primary branding color for this account.

BusinessUrl String False

The publicly visible website of the business.

ChargesEnabled Boolean True

Whether or not the account can create live charges.

Country String False

The country of the account.

CurrenciesSupportedAggregate String False

Supported currencies.

DebitNegativeBalances Boolean False

Whether or not Stripe will attempt to reclaim negative account balances from the bank account for this account.

DeclineChargeOnAvsFailure Boolean False

Whether or not Stripe should automatically decline charges with an incorrect zip/postal code.

DeclineChargeOnCvcFailure Boolean False

Whether or not Stripe should automatically decline charges with an incorrect CVC.

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.

DisplayName String False

The display name for this account. This is used on the Stripe dashboard to help you differentiate between accounts.

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.

LegalEntity String False

Information regarding the owner of this account, including verification status.

Managed Boolean False

Whether or not the account is managed by your platform. Returns null if the account was not created by a platform.

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

StatementDescriptor String False

The text that will appear on credit card statements.

SupportEmail String False

The publicly shareable email address that can be reached for support for this account.

SupportPhone String False

The publicly visible support phone number for the business.

SupportUrl String False

The publicly shareable URL that can be reached for support for this account

Timezone String False

The timezone used in the Stripe dashboard for this account.

TosAcceptance String False

Who accepted the Stripe terms of service, and when they accepted it.

TransferSchedule String False

When payments collected will be automatically paid out to the bank account of the account holder.

Verification 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

The account metadata 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



BankAccounts

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

Table Specific Information
Select
Server-Side Query Support

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

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 retreive a Bank Account by specifying its Id:

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

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

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

SELECT * FROM BankAccountTokens WHERE Id='btok_12345678'

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.

AccountNumber String False

The type of entity that holds the account.

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.

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
Select
Server-Side Query Support

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

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 retreive a Card by specifying its Id:

SELECT * FROM Cards WHERE CustomerId='cus_12345678' AND Id='ca_12345678'



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.

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

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

SELECT * FROM CardTokens WHERE Id='tok_12345678'



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.

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.

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

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

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



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.

DisputeAggregate String True

The details about the dispute if the charge has been disputed.

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

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

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

-Coupons list:

SELECT * FROM Coupons

-A specific Coupon by specifying its Id:

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

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

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

-Customers Discount list:

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

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.

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.

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

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

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



Columns

Name Type ReadOnly References Description
Id [KEY] String True

The Id of the customer.

AccountBalance Integer False

The current balance of the customer.

AddressAggregate String False

The customer's address.

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.

Description String False

The customer description.

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.

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.



InvoiceLineItems

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

Table Specific Information
Select
Server-Side Query Support

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

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

-an All InvoiceLineItems:

SELECT * FROM InvoiceLineItems 

-an InvoiceLineItems by specifying its Id:

SELECT * FROM InvoiceLineItems WHERE Id='or_12345678'

-InvoiceLineItems for a given Customer:

SELECT * FROM InvoiceLineItems 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.

Description String False

An arbitrary string attached to the object. Often useful for displaying to users.

Discountable Boolean False

If true, discounts will apply to this line item. Always false for prorations.

PeriodStart Datetime False

The set of key/value pairs that you can attach to a customer object.

PeriodEnd Datetime False

The set of key/value pairs that you can attach to a customer object.

PlanId String False

The set of key/value pairs that you can attach to a customer object.

PlanAggregate String True

The plan of the subscription, if the line item is a subscription or a proration.

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

When type is invoiceitem, the subscription that the invoice item pertains to, if any. Left blank when type is already subscription, as it'd be redundant with id.

MetadataAggregate String False

The metadata 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 invoice line items for



Invoices

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

Table Specific Information
Select
Server-Side Query Support

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

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

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

Name Type ReadOnly References Description
Id [KEY] String True

The Id of the invoice.

CustomerId String False

Customers.Id

The Id of the invoice holder.

AmountDue Int True

The amount, in cents, that was paid.

AmountPaid Int True

The amount remaining, in cents, that is due.

AmountRemaining Int True

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.

ApplicationFee Int False

Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.

AttemptCount Int True

The creation date.

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

Billing String True

Start of the current period that the subscription has been invoiced for.

Charge String True

The id of the discount.

Closed Boolean False

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.

Currency String True

The quantity of the plan to which the customer should be subscribed. For example, if your plan is $10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged $50 (5 x $10) monthly.

Date Datetime True

Date the most recent update to this subscription started.

Description String False

The status of the subscription

The allowed values are trialing, active, past_due, canceled, unpaid.

DiscountName String True

Name of the coupon.

DiscountAmount String True

If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.

CouponId String True

Id of the coupon.

DueDate Datetime False

If the subscription has a trial, the end of that trial.

EndingBalance Int True

If the subscription has a trial, the beginning of that trial.

Forgiven Boolean False

The set of key/value pairs that you can attach to a subscription object.

InvoicePdf String True

The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.

Livemode Boolean True

The status of the subscription

The allowed values are trialing, active, past_due, canceled, unpaid.

MetadataAggregate String False

The set of key/value pairs that you can attach to a subscription object.

NextPaymentAttempt Datetime True

If the subscription has a trial, the end of that trial.

Number String True

If the subscription has a trial, the beginning of that trial.

Paid String False

The status of the subscription

The allowed values are trialing, active, past_due, canceled, unpaid.

PeriodEnd Datetime True

If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.

PeriodStart Datetime True

If the subscription has a trial, the end of that trial.

ReceiptNumber String True

If the subscription has a trial, the beginning of that trial.

StartingBalance Int True

The status of the subscription

The allowed values are trialing, active, past_due, canceled, unpaid.

StatementDescriptor String False

If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.

Subscription String True

If the subscription has a trial, the end of that trial.

Subtotal Int True

If the subscription has a trial, the beginning of that trial.

Tax Int True

The status of the subscription

The allowed values are trialing, active, past_due, canceled, unpaid.

TaxPercent Decimal False

If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.

Total Int True

If the subscription has a trial, the end of that trial.

WebhooksDeliveredAt Datetime True

If the subscription has a trial, the beginning of that trial.

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



Payouts

Query the available Payouts in Stripe.

Table Specific Information
Select
Server-Side Query Support

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

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

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.

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

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

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



Columns

Name Type ReadOnly References Description
Id [KEY] String False

The Id of the plan.

Amount Decimal False

The amount in cents to be charged on the interval specified.

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.

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.

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

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

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


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

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

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

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



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.

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

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

-Subscriptions Discount list:

SELECT * FROM SubscriptionDiscounts



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.

Duration String False

One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.

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.

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

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 retreive a SubscriptionItem by specifying its Id:

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

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

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

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



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.

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

To query 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, 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 retreive a Reversal by specifying its Id:

SELECT * FROM  TransferReversals WHERE Id='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.

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

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

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



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.

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.





ViewsBack To Top

  1. AvailableBalance
  2. BalanceChangeFromActivitySummaryReport
  3. BalanceSummaryReport
  4. BalanceTransactions
  5. CountrySpecs
  6. Disputes
  7. EndingBalanceReconciliationSummaryReport
  8. Events
  9. ItemizedBalanceChangeFromActivityReport
  10. ItemizedEndingBalanceReconciliationReport
  11. ItemizedPayoutReconciliationReport
  12. ItemizedPayoutsReport
  13. ItemizedReconciliationForASinglePayoutReport
  14. Orders
  15. PayoutsReconciliationSummaryForASinglePayoutReport
  16. PayoutsReconciliationSummaryReport
  17. PayoutsSummaryReport
  18. PendingBalance
  19. Products
  20. Reports
  21. Skus

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.

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.

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


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



BalanceSummaryReport

Query the Balance Summary report in Stripe.

Table Specific Information

It is used to query the Balance 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.

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


// 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 BalanceSummaryReport where ParametersIntervalStart = '2020-12-27' and ParametersIntervalEnd = '2020-12-28' 
Select

To query the report we can try the below queries.

SELECT * FROM BalanceSummaryReport where Id IN (Select Id from Reports where report_type='balance.summary.1')

SELECT * FROM BalanceSummaryReport where Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports

SELECT * FROM BalanceSummaryReport where Id='frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report
Columns

Name Type References Description
Category String One of starting_balance, ending_balance, activity or payouts.
Description String One of Starting balance (YYYY-MM-DD) - the balance at the start of the period, Activity - the net amount of all transactions that affected your balance except for payouts, Less payouts - the amount of payouts to your bank account, or Ending balance (YYYY-MM-DD) - the balance left over at the end of the period after subtracting payouts from the Starting balance and Activity.
Net_Amount Decimal Net amount for the transactions associated with category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Currency String Three-letter ISO code for the currency in which net_amount is defined.
Id 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 driver 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 driver.

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.
SourcedTransfers String The transfers (if any) for which source is a source_transaction.
Status String If the net funds of the transaction are available in the Stripe balance yet. Either available or pending.
Type String Transaction type.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
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 driver 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 driver.

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

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

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

-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 subscription of the customer 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.

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.

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


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

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

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

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.



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.

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


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

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


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

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


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

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


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

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


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

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

-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



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.

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


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

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


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

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


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

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

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

-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.
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.
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..
Skus String A sublist of active SKUs associated with this product.
Url String The URL of a publicly-accessible webpage for this product.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AccountId String The Id of the connected account to get 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 we can set using the LiveAPIKey connection property. The view will not be visible without mentioning the LiveAPIKey.

Select
Server-Side Query Support

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


SELECT * FROM Reports

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.



Skus

Query the available SKUs in Stripe.

Table Specific Information
Select
Server-Side Query Support

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

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

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

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.