Skip to main content

Stripe Reader programmer's reference

This section provides a reference for the specific objects that the Stripe Reader supports and a guide to the Stripe Reader's properties.

Supported Objects

The Stripe Reader supports the following tables. You may download a GraphML-format entity relationship diagram for these tables from https://github.com/striim/doc-downloads.

  • Accounts

  • AvailableBalance

  • BalanceChangeFromActivitySummaryReport

  • BalanceSummaryReport

  • BalanceTransactions

  • BankAccounts

  • Cards

  • Charges

  • CheckoutSession

  • CountrySpecs

  • Coupons

  • CreditNotes

  • Customers

  • CustomerSubscriptions

  • Disputes

  • EarlyFraudWarning

  • EndingBalanceReconciliationSummaryReport

  • Events

  • Files

  • InvoiceDiscounts

  • InvoiceItemDiscounts

  • InvoiceItems

  • InvoiceLineItemDiscounts

  • InvoiceLineItems

  • Invoices

  • ItemizedBalanceChangeFromActivityReport

  • ItemizedEndingBalanceReconciliationReport

  • ItemizedPayoutReconciliationReport

  • ItemizedPayoutsReport

  • ItemizedReconciliationForASinglePayoutReport

  • Orders

  • PaymentIntent

  • PaymentLinkLineItems

  • PaymentLinks

  • PaymentMethods

  • Payouts

  • PayoutsReconciliationSummaryForASinglePayoutReport

  • PayoutsReconciliationSummaryReport

  • PayoutsSummaryReport

  • PendingBalance

  • Persons

  • Plans

  • Prices

  • Products

  • PromotionCodes

  • Quotes

  • Refunds

  • Reports

  • Reviews

  • ShippingRates

  • Skus

  • SubscriptionItems

  • Subscriptions

  • TaxRates

  • TopUps

  • TransferReversals

  • Transfers

  • UsageRecords

  • ValueListItems

  • ValueLists

Stripe Reader properties

Property

Type

Default value

Notes

Account ID

String

The ID of a connected account.

API key

Password

Enables direct access to the Stripe Platform.

Connected account

Boolean

False

Enables reading data from a Stripe connected account. A connected account is a Stripe account that sends payments to the primary Stripe account.

Connection pool size

Integer

20

Specifies the maximum number of simultaneous active connections.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

Value of the created field.

The incremental load marker is a unique incremental column in each object used for incremental load. When this marker is absent, tables are resynced at every polling interval.

Migrate schema

Boolean

False

Only available in Initial Load or Automated modes. Set to True to enable initial schema migration to the target.

Mode

Select list

  • Initial load

  • Incremental load

  • Automated mode

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

String

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s).

Start position

String

%=-1

Value of the incremental load marker that defines the initial reading position. The % wildcard matches all tables. -1 is the latest possible start; 0 is the earliest.

Tables

String

A semicolon-delimited (;) list of objects to read from the Stripe instance. Supports the % wildcard. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

For best performance, size the connection pool to match the number of threads.