Stripe integration summary

Stitch’s Stripe integration replicates data using the Stripe REST API. Refer to the Schema section for a list of objects available for replication.

Stripe feature snapshot

A high-level look at Stitch's Stripe (v2) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on June 20, 2022

 Supported by

Stitch
Stitch plan

Standard

 API availability

Available
Singer GitHub repository

singer-io/tap-stripe
REPLICATION SETTINGS
Anchor Scheduling

Supported

 Advanced Scheduling

Supported
Table-level reset

Unsupported

 Configurable Replication Methods

Unsupported
DATA SELECTION
Table selection

Supported

 Column selection

Supported
Select all

Supported
TRANSPARENCY
Extraction Logs

Supported

 Loading Reports

Supported

Connecting Stripe

Stripe setup requirements

To set up Stripe in Stitch, you need:

  • Administrator permissions in Stripe. This is required to grant Stitch access to Stripe.

Step 1: Add Stripe as a Stitch data source

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Stripe icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Stripe” would create a schema called stitch_stripe in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the Lookback window field, enter the number of historical days’ worth of data you would like to replicate from the start date. The maximum lookback period is 600 days. This field is optional. Head to the Lookback windows and data extraction section to learn more about this.

Step 2: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Stripe integration. This means that:

  • For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
  • For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.

Change this setting if you want to replicate data beyond Stripe’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 3: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Stripe integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 4: Authorize Stitch to access Stripe

  1. Next, you’ll be prompted to sign into your Stripe account.
  2. A screen explaining what you’re authorizing will display. Note: Stitch will only ever read your Stripe data, and cannot create charges or any other records in Stripe.
  3. Click Sign in with Stripe to connect.
  4. Sign into your Stripe account.
  5. After the authorization process is successfully completed, you’ll be directed back to Stitch.
  6. Click All Done.

Step 5: Set objects to replicate

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Stripe integrations, you can select:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.

  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.

  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.

  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Stripe, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Stripe replication

Events table replication

Stripe will only provide 30 days of historical event data for the events table. Refer the the Stripe docs for more information about the events table.

Objects and events

In the Stripe API, there are two concepts:

  • Objects, which are items like charges, invoices, customers, etc.
  • Events, which are changes to objects. For example: An invoice being created, or its status going from draft to open.

Whenever an object is created or updated in Stripe, a corresponding event is created. Because Stripe creates and updates object records in this way, there are two types of tables in Stitch’s Stripe integration:

  • A table for events, which contains all events that have occurred for Stripe’s supported event types. This table acts as a history for an object record, showing how it has been changed over time.
  • Tables for objects, which contains the latest version of records. These are tables like customers, charges, invoices, etc.

Note: Updates based on events is only applicable to the type of object the event is for. For example: If a dispute object is updated, only the corresponding record in the disputes table will be updated. The related charge in the charges table will not be updated. To retrieve related data for different objects, you’ll need to use the events table. Refer to Stripe’s documentation for info about event types and the objects they describe.

Example event and object data replication over time

In the image below is an example of how records for the events and invoices tables will look as an invoice changes over time. Click the image to enlarge.

Example showing how event and invoice records are replicated as an invoice changes over time

Lookback windows and data extraction

When Stitch runs a replication job for Stripe, you can use a configurable lookback window of up to 600 days to query and extract data for your tables. A lookback window is a period of time for attributing shared files and the lookback period after those actions occur.

While Stitch replicates data in this way to account for updates to records made during the lookback window, it can have a substantial impact on your overall row usage.

In the sections below are examples of how lookback windows impact how Stitch extracts data during historical and ongoing replication jobs.

For historical and full re-replications of Stripe data, Stitch will query for and extract data newer than or equal to the date defined in the Start Date field in the Integration Settings page.

The Start Date, in conjunction with the Lookback Window, defines the minimum date Stitch should query for when extracting historical data. This is calculated as:

Start Date - Lookback Window = Minimum Extraction Date

Example

During the initial set up, the Lookback Window and Start Date settings are defined as:

  • Lookback Window: 600 days (default setting)
  • Start Date: 07/03/2017, or 2017-07-03 00:00:00

To account for the Lookback Window, Stitch would calculate the Minimum Extraction Date value as: 2017-07-03 00:00:00 - 600 days = 2015-11-11 00:00:00

If you were to write a SQL query using this date for the charges table, it might look like this:

  SELECT *
    FROM stripe.charges
   WHERE created >= '2015-11-11 00:00:00'   /* Min. Extraction Date */
ORDER BY created

For ongoing replication jobs, Stitch will query for and extract data using the last saved maximum value in the table’s Replication Key column and the Lookback Window for the table.

Note: This applies to every replication job that takes place after the historical replication job.

Example

The last maximum saved Replication Key value for the charges table is 2017-10-01 00:00:00.

To account for the Lookback Window of 600 days, we’d subtract this from the last maximum saved Replication Key value:

2017-10-01 00:00:00 - 600 days = 2016-02-09 00:00:00

In this case, Stitch would query for and extract data that is newer than or equal to 2016-02-09 00:00:00 and older than or equal to 2017-10-01 00:00:00.

If this were a SQL query, it might look like this:

  SELECT *
    FROM charges
   WHERE created >= '2016-02-09 00:00:00'
                              /* max Replication Key value - Lookback Window */
     AND created <= '2017-10-01 00:00:00'
                              /* max Replication Key value from previous job */
ORDER BY created

Stripe table reference

balance_transactions

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

created
Primary Key :

id

 API endpoint :

List all balance history

The balance_transactions table contains info about transactions have have contributed to your Stripe account balance, including charges, transfers, etc.

balance_transactions table schema

id
STRING

The balance transaction ID.

Reference:

created
STRING

The time at which the object was created.

amount
INTEGER

available_on
INTEGER

currency
STRING

The three-letter ISO currency code.

description
STRING

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

exchange_rate
NUMBER

fee
INTEGER

fee_details
ARRAY

Detailed breakdown of fees (in cents) paid for this transaction.

Click to expand fee_details

application
STRING

type
STRING

description
STRING

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

amount
INTEGER

Amount of the fee, in cents.

currency
STRING

The three-letter ISO currency code.
balance_transactions (table), fee_details (attribute)

net
INTEGER

Net amount of the transaction, in cents.

object
STRING

The type of Stripe object. This will be balance_transaction.

source
STRING

The Stripe object to which this transaction is related.

sourced_transfers
ARRAY

Click to expand sourced_transfers

items

balance_transactions (table), sourced_transfers (attribute)

status
STRING

Indicates if the transaction’s net funds are available in the Stripe. Possible values are available or pending.

type
STRING

The type of the transaction. Refer to Stripe’s documentation for a list of possible values.

updated
STRING

The time at which the balance transaction was last updated.

charges

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

created
Primary Key :

id

 API endpoint :

List all charges

The charges table contains info about charges to credit and debit cards.

charges table schema

id
STRING

The charge ID.

Reference:

created
STRING

Time at which the object was created. Measured in seconds since the Unix epoch.

amount
INTEGER

A positive integer in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency) representing how much to charge. The minimum amount is $0.50 USD or equivalent in charge currency.

amount_captured
INTEGER

amount_refunded
INTEGER

Amount in cents refunded (can be less than amount if a partial refund was issued).

application
STRING

The ID of the Connect application that created the charge.

application_fee
STRING

application_fee_amount
INTEGER

balance_transaction
STRING

billing_details
OBJECT

Click to expand billing_details

address
OBJECT

Click to expand address

city
STRING

country
STRING

line1
STRING

line2
STRING

postal_code
STRING

state
STRING

charges (table), address (attribute)

email
STRING

name
STRING

phone
STRING

charges (table), billing_details (attribute)

calculated_statement_descriptor
STRING

captured
BOOLEAN

card
OBJECT

Details about the credit or debit card that is the source of the charge.

Click to expand card

metadata
OBJECT

exp_month
INTEGER

address_state
STRING

id
STRING

The card ID.

Reference:

object
STRING

address_line1_check
STRING

address_line1
STRING

exp_year
INTEGER

tokenization_method
STRING

address_country
STRING

fingerprint
STRING

address_city
STRING

last4
STRING

address_line2
STRING

customer
STRING

brand
STRING

country
STRING

dynamic_last4
STRING

name
STRING

funding
STRING

address_zip
STRING

address_zip_check
STRING

cvc_check
STRING

type
STRING

charges (table), card (attribute)

currency
STRING

The three-letter ISO currency code.

customer
STRING

The ID of the customer associated with the charge.

Reference:

description
STRING

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

destination
STRING

The account (if any) the charge was made on behalf of, with an automatic transfer.

dispute
STRING

Details about the dispute, if the charge has been disputed.

disputed
BOOLEAN

failure_code
STRING

The error code explaining the reason for a charge failure, if available. Refer to Stripe’s documentation for a list of possible error codes.

failure_message
STRING

The message that displays to the user that further explains the reason for the charge failure.

fraud_details
OBJECT

Details about fraud assessments for the charge.

Click to expand fraud_details

stripe_report
STRING

If not null, this indicates that a Stripe fraud assessment exists for the charge. This field may have a value of fraudulent.

  • safe
  • fraudulent
charges (table), fraud_details (attribute)

invoice
STRING

The ID of the invoice the charge is for.

Reference:

livemode
BOOLEAN

Indicates if the object exists in live mode (true) or in test mode (false).

metadata
OBJECT

Additional information attached to the charge.

object
STRING

The type of Stripe object. This will be charge.

on_behalf_of
STRING

The account the charge was made on behalf of without triggering an automatic transfer

order
STRING

The ID of the order this charge is for.

outcome
OBJECT

Details about whether the payment was accepted and why.

Click to expand outcome

type
STRING

The type of the outcome. Possible values are:

  • authorized
  • manual_review
  • issuer_declined
  • blocked
  • invalid

seller_message
STRING

A description of the outcome type and reason designed for you, the recipient of the payment.

reason
STRING

A detailed explanation of the outcome’s type. Possible values are:

  • highest_risk_level - Indicates the charge was blocked by Radar’s default block rule.
  • elevated_risk_level - Indicates the charge was placed in review by Radar’s default review rule.
  • rule - Indicates the charge was authorized, blocked, or placed in review by a custom rule.

Refer to Stripe’s documentation for more info about this attribute.

risk_level
STRING

Indicates Stripe’s evaluation of the riskiness of the payment. Possible values are:

  • normal, elevated, highest - Evaluated payments
  • not_assessed - Non-card payments, and card-based payments predating the public assignment of risk levels
  • unknown - Indicates an error in the risk evaluation

network_status
STRING

The network status of the outcome. Possible values are:

  • approved_by_network
  • declined_by_network
  • not_sent_to_network
  • reversed_after_approval - This value indicates that Stripe blocked the payment after bank authorization, and may temporarily appear as “pending” on a cardholder’s statement.

risk_score
INTEGER

Indicates Stripe’s evaluation of the riskiness of the payment.

  • For evaluated payments, this attribute will contain a value between 0 and 100.

  • For non-card payments, and card-based payments predating the public assignment of risk levels, this field will be null.
charges (table), outcome (attribute)

paid
BOOLEAN

Indicates if the charge succeeded (true) or was successfully authorzed for later capture (false).

payment_intent
STRING

The ID of the payment intent associated with the charge.

payment_method
STRING

payment_method_details
OBJECT

Click to expand payment_method_details

card_present
OBJECT

Click to expand card_present

amount_authorized
INTEGER

brand
STRING

cardholder_name
STRING

country
STRING

emv_auth_data
STRING

exp_month
INTEGER

exp_year
INTEGER

fingerprint
STRING

funding
STRING

generated_card
STRING

last4
STRING

network
STRING

overcapture_supported
BOOLEAN

read_method
STRING

receipt
OBJECT

Click to expand receipt

account_type
STRING

application_cryptogram
STRING

application_preferred_name
STRING

authorization_code
STRING

authorization_response_code
STRING

cardholder_verification_method
STRING

dedicated_file_name
STRING

terminal_verification_results
STRING

transaction_status_information
STRING

charges (table), receipt (attribute)

ach_credit_transfer
OBJECT

Click to expand ach_credit_transfer

account_number
STRING

bank_name
STRING

routing_number
STRING

swift_code
STRING

charges (table), ach_credit_transfer (attribute)

ach_debit
OBJECT

Click to expand ach_debit

account_holder_type
STRING

bank_name
STRING

country
STRING

fingerprint
STRING

last4
STRING

routing_number
STRING

charges (table), ach_debit (attribute)

alipay
OBJECT

bancontact
OBJECT

Click to expand bancontact

bank_code
STRING

bank_name
STRING

bic
STRING

iban_last4
STRING

preferred_language
STRING

verified_name
STRING

charges (table), bancontact (attribute)

card
OBJECT

Click to expand card

brand
STRING

checks
OBJECT

Click to expand checks

address_line1_check
STRING

address_postal_code_check
STRING

cvc_check
STRING

charges (table), checks (attribute)

country
STRING

exp_month
INTEGER

exp_year
INTEGER

fingerprint
STRING

funding
STRING

installments
OBJECT

Click to expand installments

plan
OBJECT

Click to expand plan

count
INTEGER

interval
STRING

type
STRING

charges (table), plan (attribute)
charges (table), installments (attribute)

last4
STRING

network
STRING

three_d_secure
OBJECT

Click to expand three_d_secure

authenticated
BOOLEAN

succeeded
BOOLEAN

version
STRING

charges (table), three_d_secure (attribute)

wallet
OBJECT

Click to expand wallet

amex_express_checkout
OBJECT

apple_pay
OBJECT

dynamic_last4
STRING

google_pay
OBJECT

masterpass
OBJECT

Click to expand masterpass

billing_address
OBJECT

Click to expand billing_address

city
STRING

country
STRING

line1
STRING

line2
STRING

postal_code
STRING

state
STRING

charges (table), billing_address (attribute)

email
STRING

name
STRING

shipping_address
OBJECT

Click to expand shipping_address

city
STRING

country
STRING

line1
STRING

line2
STRING

postal_code
STRING

state
STRING

charges (table), shipping_address (attribute)
charges (table), masterpass (attribute)

samsung_pay
OBJECT

type
STRING

visa_checkout
OBJECT

billing_address
OBJECT

Click to expand billing_address

city
STRING

country
STRING

line1
STRING

line2
STRING

postal_code
STRING

state
STRING

charges (table), billing_address (attribute)

email
STRING

name
STRING

shipping_address
OBJECT

Click to expand shipping_address

city
STRING

country
STRING

line1
STRING

line2
STRING

postal_code
STRING

state
STRING

charges (table), shipping_address (attribute)
charges (table), wallet (attribute)

card_present
OBJECT

Click to expand card_present

brand
STRING

country
STRING

emv_auth_data
STRING

exp_month
INTEGER

exp_year
INTEGER

fingerprint
STRING

funding
STRING

generated_card
STRING

last4
STRING

network
STRING

read_method
STRING

receipt
OBJECT

Click to expand receipt

application_cryptogram
STRING

application_preferred_name
STRING

authorization_code
STRING

authorization_response_code
STRING

cardholder_verification_method
STRING

dedicated_file_name
STRING

terminal_verification_results
STRING

transaction_status_information
STRING

charges (table), receipt (attribute)
charges (table), card_present (attribute)

eps
OBJECT

Click to expand eps

verified_name
STRING

charges (table), eps (attribute)

giropay
OBJECT

Click to expand giropay

bank_code
STRING

bank_name
STRING

bic
STRING

verified_name
STRING

charges (table), giropay (attribute)

ideal
OBJECT

Click to expand ideal

bank
STRING

bic
STRING

iban_last4
STRING

verified_name
STRING

charges (table), ideal (attribute)

klarna
OBJECT

multibanco
OBJECT

Click to expand multibanco

entity
STRING

reference
STRING

charges (table), multibanco (attribute)

p24
OBJECT

Click to expand p24

reference
STRING

verified_name
STRING

charges (table), p24 (attribute)

sepa_debit
OBJECT

Click to expand sepa_debit

bank_code
STRING

branch_code
STRING

country
STRING

fingerprint
STRING

last4
STRING

mandate
STRING

charges (table), sepa_debit (attribute)

sofort
OBJECT

Click to expand sofort

bank_code
STRING

bank_name
STRING

bic
STRING

country
STRING

iban_last4
STRING

verified_name
STRING

charges (table), sofort (attribute)

stripe_account
OBJECT

type
STRING

wechat
OBJECT

metadata
OBJECT

address_state
STRING

id
STRING

object
STRING

address_line1_check
STRING

address_line1
STRING

tokenization_method
STRING

address_country
STRING

address_city
STRING

address_line2
STRING

customer
STRING

dynamic_last4
STRING

name
STRING

address_zip
STRING

address_zip_check
STRING

cvc_check
STRING

charges (table), card (attribute)

type
STRING

charges (table), card_present (attribute)
charges (table), payment_method_details (attribute)

receipt_email
STRING

receipt_number
STRING

receipt_url
STRING

refunded
BOOLEAN

refunds
ARRAY

Click to expand refunds

items

charges (table), refunds (attribute)

review
STRING

shipping
OBJECT

source
OBJECT

Click to expand source

metadata
OBJECT

type
STRING

address_zip
STRING

livemode
BOOLEAN

card
OBJECT

Click to expand card

fingerprint
STRING

last4
STRING

dynamic_last4
STRING

address_line1_check
STRING

exp_month
INTEGER

tokenization_method
STRING

name
STRING

exp_year
INTEGER

three_d_secure
STRING

funding
STRING

brand
STRING

cvc_check
STRING

country
STRING

address_zip_check
STRING

type
STRING

charges (table), card (attribute)

statement_descriptor
STRING

id
STRING

address_country
STRING

funding
STRING

dynamic_last4
STRING

exp_year
INTEGER

last4
STRING

exp_month
INTEGER

brand
STRING

address_line2
STRING

country
STRING

object
STRING

amount
INTEGER

cvc_check
STRING

usage
STRING

address_line1
STRING

owner
OBJECT

Click to expand owner

verified_address
STRING

email
STRING

address
OBJECT

Click to expand address

line2
STRING

state
STRING

city
STRING

postal_code
STRING

country
STRING

line1
STRING

charges (table), address (attribute)

verified_email
STRING

name
STRING

phone
STRING

verified_name
STRING

verified_phone
STRING

charges (table), owner (attribute)

tokenization_method
STRING

client_secret
STRING

fingerprint
STRING

address_city
STRING

currency
STRING

address_line1_check
STRING

receiver
OBJECT

Click to expand receiver

refund_attributes_method
STRING

amount_returned
INTEGER

amount_received
INTEGER

refund_attributes_status
STRING

address
STRING

amount_charged
INTEGER

charges (table), receiver (attribute)

flow
STRING

name
STRING

ach_credit_transfer
OBJECT

Click to expand ach_credit_transfer

bank_name
STRING

fingerprint
STRING

routing_number
STRING

swift_code
STRING

refund_account_holder_type
STRING

refund_account_holder_name
STRING

refund_account_number
STRING

refund_routing_number
STRING

account_number
STRING

charges (table), ach_credit_transfer (attribute)

customer
STRING

address_zip_check
STRING

status
STRING

created
STRING

address_state
STRING

alipay
OBJECT

bancontact
OBJECT

eps
OBJECT

ideal
OBJECT

multibanco
OBJECT

redirect
OBJECT

Click to expand redirect

failure_reason
STRING

return_url
STRING

status
STRING

url
STRING

charges (table), redirect (attribute)
charges (table), source (attribute)

source_transfer
STRING

statement_description
STRING

statement_descriptor
STRING

statement_descriptor_suffix
STRING

status
STRING

transfer_data
OBJECT

Click to expand transfer_data

amount
INTEGER

destination
STRING

charges (table), transfer_data (attribute)

transfer_group
STRING

updated
STRING

updated_by_event_type
STRING

Description of the event

coupons

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

created
Primary Key :

id

 API endpoint :

List all coupons

The coupons table contains info about percent or amount-off discounts that may be applied to a customer. Note: Coupons only apply to invoices; they don’t apply to one-off charges.

coupons table schema

id
STRING

The coupon ID.

Reference:

created
STRING

Time at which the object was created. Measured in seconds since the Unix epoch.

amount_off
INTEGER

currency
STRING

duration
STRING

duration_in_months
INTEGER

livemode
BOOLEAN

max_redemptions
INTEGER

metadata
OBJECT

name
STRING

object
STRING

percent_off
NUMBER

percent_off_precise
NUMBER

redeem_by
STRING

times_redeemed
INTEGER

updated
STRING

updated_by_event_type
STRING

Description of the event

valid
BOOLEAN

customers

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

created
Primary Key :

id

 API endpoint :

List all customers

The customers table contains info about your customers.

customers table schema

id
STRING

The customer ID.

Reference:

created
STRING

Time at which the object was created. Measured in seconds since the Unix epoch.

account_balance
INTEGER

address
OBJECT

Click to expand address

city
STRING

country
STRING

line1
STRING

line2
STRING

postal_code
STRING

state
STRING

customers (table), address (attribute)

balance
INTEGER

cards
ARRAY

Click to expand cards

metadata
OBJECT

object
STRING

id
STRING

exp_month
INTEGER

dynamic_last4
STRING

exp_year
INTEGER

last4
STRING

funding
STRING

brand
STRING

country
STRING

customer
STRING

cvc_check
STRING

address_line2
STRING

address_line1
STRING

fingerprint
STRING

address_zip
STRING

address_city
STRING

address_country
STRING

address_line1_check
STRING

tokenization_method
STRING

name
STRING

address_state
STRING

address_zip_check
STRING

type
STRING

customers (table), cards (attribute)

currency
STRING

default_card
STRING

default_source
STRING

delinquent
BOOLEAN

description
STRING

discount
OBJECT

Click to expand discount

end
STRING

coupon
OBJECT

Click to expand coupon

metadata
OBJECT

valid
BOOLEAN

livemode
BOOLEAN

amount_off
INTEGER

redeem_by
STRING

duration_in_months
INTEGER

percent_off_precise
NUMBER

max_redemptions
INTEGER

currency
STRING

name
STRING

times_redeemed
INTEGER

id
STRING

The ID of the discount object.

duration
STRING

object
STRING

percent_off
NUMBER

created
STRING

customers (table), coupon (attribute)

customer
STRING

start
STRING

object
STRING

subscription
STRING

checkout_session
STRING

id
STRING

The ID of the discount object.

invoice
STRING

The invoice that the discount’s coupon was applied to, if it was applied directly to a particular invoice.

invoice_item
STRING

The invoice item id (or invoice line item id for invoice line items of type=‘subscription’) that the discount’s coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.

promotion_code
STRING

The promotion code applied to create this discount.
customers (table), discount (attribute)

email
STRING

invoice_prefix
STRING

invoice_settings
OBJECT

Click to expand invoice_settings

custom_fields
ARRAY

Click to expand custom_fields

items
STRING

customers (table), custom_fields (attribute)

default_payment_method
STRING

footer
STRING

customers (table), invoice_settings (attribute)

livemode
BOOLEAN

metadata
OBJECT

name
STRING

next_invoice_sequence
INTEGER

object
STRING

phone
STRING

preferred_locales
ARRAY

Click to expand preferred_locales

items
STRING

customers (table), preferred_locales (attribute)

shipping
OBJECT

Click to expand shipping

address
OBJECT

Click to expand address

line2
STRING

state
STRING

city
STRING

postal_code
STRING

country
STRING

line1
STRING

customers (table), address (attribute)

name
STRING

phone
STRING

customers (table), shipping (attribute)

sources
ARRAY

Click to expand sources

metadata
OBJECT

type
STRING

address_zip
STRING

livemode
BOOLEAN

card
OBJECT

Click to expand card

fingerprint
STRING

last4
STRING

dynamic_last4
STRING

address_line1_check
STRING

exp_month
INTEGER

tokenization_method
STRING

name
STRING

exp_year
INTEGER

three_d_secure
STRING

funding
STRING

brand
STRING

cvc_check
STRING

country
STRING

address_zip_check
STRING

type
STRING

customers (table), card (attribute)

statement_descriptor
STRING

id
STRING

address_country
STRING

funding
STRING

dynamic_last4
STRING

exp_year
INTEGER

last4
STRING

exp_month
INTEGER

brand
STRING

address_line2
STRING

country
STRING

object
STRING

amount
INTEGER

cvc_check
STRING

usage
STRING

address_line1
STRING

owner
OBJECT

Click to expand owner

verified_address
STRING

email
STRING

address
OBJECT

Click to expand address

line2
STRING

state
STRING

city
STRING

postal_code
STRING

country
STRING

line1
STRING

customers (table), address (attribute)

verified_email
STRING

name
STRING

phone
STRING

verified_name
STRING

verified_phone
STRING

customers (table), owner (attribute)

tokenization_method
STRING

client_secret
STRING

fingerprint
STRING

address_city
STRING

currency
STRING

address_line1_check
STRING

receiver
OBJECT

Click to expand receiver

refund_attributes_method
STRING

amount_returned
INTEGER

amount_received
INTEGER

refund_attributes_status
STRING

address
STRING

amount_charged
INTEGER

customers (table), receiver (attribute)

flow
STRING

name
STRING

ach_credit_transfer
OBJECT

Click to expand ach_credit_transfer

bank_name
STRING

fingerprint
STRING

routing_number
STRING

swift_code
STRING

refund_account_holder_type
STRING

refund_account_holder_name
STRING

refund_account_number
STRING

refund_routing_number
STRING

account_number
STRING

customers (table), ach_credit_transfer (attribute)

customer
STRING

address_zip_check
STRING

status
STRING

created
STRING

address_state
STRING

alipay
OBJECT

bancontact
OBJECT

eps
OBJECT

ideal
OBJECT

multibanco
OBJECT

redirect
OBJECT

Click to expand redirect

failure_reason
STRING

return_url
STRING

status
STRING

url
STRING

customers (table), redirect (attribute)
customers (table), sources (attribute)

sources
OBJECT

Click to expand sources

metadata
OBJECT

type
STRING

address_zip
STRING

livemode
BOOLEAN

card
OBJECT

Click to expand card

fingerprint
STRING

last4
STRING

dynamic_last4
STRING

address_line1_check
STRING

exp_month
INTEGER

tokenization_method
STRING

name
STRING

exp_year
INTEGER

three_d_secure
STRING

funding
STRING

brand
STRING

cvc_check
STRING

country
STRING

address_zip_check
STRING

type
STRING

customers (table), card (attribute)

statement_descriptor
STRING

id
STRING

address_country
STRING

funding
STRING

dynamic_last4
STRING

exp_year
INTEGER

last4
STRING

exp_month
INTEGER

brand
STRING

address_line2
STRING

country
STRING

object
STRING

amount
INTEGER

cvc_check
STRING

usage
STRING

address_line1
STRING

owner
OBJECT

Click to expand owner

verified_address
STRING

email
STRING

address
OBJECT

Click to expand address

line2
STRING

state
STRING

city
STRING

postal_code
STRING

country
STRING

line1
STRING

customers (table), address (attribute)

verified_email
STRING

name
STRING

phone
STRING

verified_name
STRING

verified_phone
STRING

customers (table), owner (attribute)

tokenization_method
STRING

client_secret
STRING

fingerprint
STRING

address_city
STRING

currency
STRING

address_line1_check
STRING

receiver
OBJECT

Click to expand receiver

refund_attributes_method
STRING

amount_returned
INTEGER

amount_received
INTEGER

refund_attributes_status
STRING

address
STRING

amount_charged
INTEGER

customers (table), receiver (attribute)

flow
STRING

name
STRING

ach_credit_transfer
OBJECT

Click to expand ach_credit_transfer

bank_name
STRING

fingerprint
STRING

routing_number
STRING

swift_code
STRING

refund_account_holder_type
STRING

refund_account_holder_name
STRING

refund_account_number
STRING

refund_routing_number
STRING

account_number
STRING

customers (table), ach_credit_transfer (attribute)

customer
STRING

address_zip_check
STRING

status
STRING

created
STRING

address_state
STRING

alipay
OBJECT

bancontact
OBJECT

eps
OBJECT

ideal
OBJECT

multibanco
OBJECT

redirect
OBJECT

Click to expand redirect

failure_reason
STRING

return_url
STRING

status
STRING

url
STRING

customers (table), redirect (attribute)
customers (table), sources (attribute)

subscriptions
ARRAY

Click to expand subscriptions

items
STRING

customers (table), subscriptions (attribute)

tax_exempt
STRING

tax_ids
ARRAY

Click to expand tax_ids

id
STRING

Unique identifier for the object.

object
STRING

String representing the object’s type. Objects of the same type share the same value.

country
STRING

Two-letter ISO code representing the country of the tax ID.

created
STRING

Time at which the object was created. Measured in seconds since the Unix epoch.

customer
STRING

ID of the customer.

livemode
BOOLEAN

Has the value true if the object exists in live mode or the value false if the object exists in test mode

type
STRING

Type of the tax ID.

value
STRING

Value of the tax ID

verification
OBJECT

Tax ID verification information.

Click to expand verification

status
STRING

verified_address
STRING

verified_name
STRING

customers (table), verification (attribute)
customers (table), tax_ids (attribute)

tax_ids
OBJECT

Click to expand tax_ids

id
STRING

Unique identifier for the object.

object
STRING

String representing the object’s type. Objects of the same type share the same value.

country
STRING

Two-letter ISO code representing the country of the tax ID.

created
STRING

Time at which the object was created. Measured in seconds since the Unix epoch.

customer
STRING

ID of the customer.

livemode
BOOLEAN

Has the value true if the object exists in live mode or the value false if the object exists in test mode

type
STRING

Type of the tax ID.

value
STRING

Value of the tax ID

verification
OBJECT

Tax ID verification information.

Click to expand verification

status
STRING

verified_address
STRING

verified_name
STRING

customers (table), verification (attribute)
customers (table), tax_ids (attribute)

tax_info
STRING

tax_info_verification
STRING

updated
STRING

updated_by_event_type
STRING

Description of the event

disputes

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

created
Primary Key :

id

 API endpoint :

List all disputes

This table contains information about customer disputes related to charges on their credit card.

disputes table schema

id
STRING

The dispute ID.

Reference:

created
STRING

Time at which the dispute was created. Measured in seconds since the Unix epoch.

amount
INTEGER

balance_transactions
ARRAY

charge
STRING

The ID of the disputed charge.

Reference:

currency
STRING

evidence
STRING, OBJECT

Click to expand evidence

refund_policy
STRING

shipping_address
STRING

duplicate_charge_explanation
STRING

shipping_tracking_number
STRING

customer_signature
STRING

uncategorized_text
STRING

cancellation_policy_disclosure
STRING

refund_policy_disclosure
STRING

receipt
STRING

customer_name
STRING

refund_refusal_explanation
STRING

cancellation_rebuttal
STRING

product_description
STRING

shipping_date
STRING

customer_email_address
STRING

duplicate_charge_id
STRING

shipping_documentation
STRING

access_activity_log
STRING

customer_purchase_ip
STRING

service_date
STRING

shipping_carrier
STRING

service_documentation
STRING

duplicate_charge_documentation
STRING

cancellation_policy
STRING

customer_communication
STRING

uncategorized_file
STRING

billing_address
STRING

disputes (table), evidence (attribute)

evidence_details
OBJECT

Click to expand evidence_details

due_by
STRING

has_evidence
BOOLEAN

past_due
BOOLEAN

submission_count
INTEGER

disputes (table), evidence_details (attribute)

is_charge_refundable
BOOLEAN

livemode
BOOLEAN

metadata
OBJECT

object
STRING

reason
STRING

status
STRING

updated
STRING

updated_by_event_type
STRING

Description of the event

events

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

created
Primary Key :

id

 API endpoint :

List all events

The events table contains info about events. When an event occurs, a new event object is created. This table acts as the history of an object, allowing you to see how it has changed over time.

For example: When an invoice is created, an invoice.created event is created. When the draft invoice is finalized and updated to be open, an invoice.finalized event is created. When the invoice is sent to the customer, an invoice.sent event is created.

For more info about this table and how data is replicated, refer to the Replication section. Additionally, refer to Stripe’s documentation for info about event types and the objects they describe.

events table schema

id
STRING

The event ID.

Reference:

created
STRING

The time at which the object was created. Measured in seconds since the Unix epoch.

api_version
STRING

data
OBJECT

livemode
BOOLEAN

object
STRING

pending_webhooks
INTEGER

request
STRING

type
STRING

updated
STRING

invoices

View table schema on GitHub