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 (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on December 1, 2018

 Supported by

Stitch
Stitch plan

Standard

 API availability

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

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

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

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

amount
INTEGER

The gross amount of the transaction, in cents.

available_on
INTEGER

The date the transaction’s net funds will become available in the Stripe balance.

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

The exchange rate for the currency.

fee
INTEGER

The fees (in cents) paid for this transaction.

fee_details
ARRAY

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

Click to expand fee_details

amount
INTEGER

Amount of the fee, in cents.

application
STRING

currency
STRING

The three-letter ISO currency code.

description
STRING

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

type
STRING

The type of the fee. Possible values are:

  • application_fee
  • stripe_fee
  • tax
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

value
ANYTHING

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

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

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

The application fee (if any) for the charge.

application_fee_amount
INTEGER

balance_transaction
STRING

The ID of the balance transaction that describes the impact of this charge on the Stripe account.

Reference:

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

If the charge was created without capturing, this attribute will indicate whether it’s still uncaptured or has since been captured.

card
OBJECT

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

Click to expand card

id
STRING

The card ID.

Reference:

address_city
STRING

The city associated with the card’s billing address.

address_country
STRING

The billing address country.

address_line1
STRING

The first line of the billing address.

address_line1_check
STRING

If address_line1 was provided, the results of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

address_line2
STRING

The second line of the billing address.

address_state
STRING

The state/county/province/region of the billing address.

address_zip
STRING

The zip or postal code of the billing address.

address_zip_check
STRING

If address_zip was provided, the results of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

brand
STRING

The brand of the card. Possible values are:

  • American Express
  • Diners Club
  • Discover
  • JCB
  • MasterCard
  • UnionPay
  • Visa
  • Unknown

country
STRING

The two-letter ISO code representing the country of the card.

customer
STRING

The ID of the customer that the card belongs to.

Reference:

cvc_check
STRING

If a CVC was provided, this will be the result of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

dynamic_last4
STRING

For tokenized numbers only. The last four digits of the device account number.

exp_month
INTEGER

The two-digit number representing the card’s expiration month.

exp_year
INTEGER

The four-digit number representing the card’s expiration year.

fingerprint
STRING

A unique ID for the card number.

funding
STRING

The card’s funding type. Possible values are:

  • credit
  • debit
  • prepaid
  • unknown

last4
STRING

The last four digits of the card.

metadata
OBJECT

Additional information attached to the card.

Click to expand metadata

ANYTHING
ANYTHING

This info will vary.
charges (table), metadata (attribute)

name
STRING

The name of the cardholder.

object
STRING

The type of Stripe object. This will be card.

tokenization_method
STRING

If the card number is tokenized, this is the method that was used. Possible values are:

  • apple_pay
  • android_pay
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.

user_report
STRING

If not null, this indicates that a fraud assessment reported by you exists for the charge. Possible values are:

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

Click to expand metadata


charges (table), metadata (attribute)

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

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.

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

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.

seller_message
STRING

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

type
STRING

The type of the outcome. Possible values are:

  • authorized
  • manual_review
  • issuer_declined
  • blocked
  • invalid
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

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

address_city
STRING

address_country
STRING

address_line1
STRING

address_line1_check
STRING

address_line2
STRING

address_state
STRING

address_zip
STRING

address_zip_check
STRING

brand
STRING

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)

checks
OBJECT

Click to expand checks

address_line1_check
STRING

address_postal_code_check
STRING

cvc_check
STRING

charges (table), checks (attribute)

country
STRING

customer
STRING

cvc_check
STRING

dynamic_last4
STRING

eps
OBJECT

Click to expand eps

verified_name
STRING

charges (table), eps (attribute)

exp_month
INTEGER

exp_year
INTEGER

fingerprint
STRING

funding
STRING

giropay
OBJECT

Click to expand giropay

bank_code
STRING

bank_name
STRING

bic
STRING

verified_name
STRING

charges (table), giropay (attribute)

id
STRING

ideal
OBJECT

Click to expand ideal

bank
STRING

bic
STRING

iban_last4
STRING

verified_name
STRING

charges (table), ideal (attribute)

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)

klarna
OBJECT

last4
STRING

metadata
OBJECT

multibanco
OBJECT

Click to expand multibanco

entity
STRING

reference
STRING

charges (table), multibanco (attribute)

name
STRING

network
STRING

object
STRING

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

Click to expand stripe_account

charges (table), stripe_account (attribute)

three_d_secure
OBJECT

Click to expand three_d_secure

authenticated
BOOLEAN

succeeded
BOOLEAN

version
STRING

charges (table), three_d_secure (attribute)

tokenization_method
STRING

type
STRING

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

Click to expand visa_checkout

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), visa_checkout (attribute)
charges (table), wallet (attribute)

wechat
OBJECT

charges (table), card (attribute)

type
STRING

charges (table), payment_method_details (attribute)

receipt_email
STRING

The email address that the receipt for the charge was sent to.

receipt_number
STRING

The transaction number that appears on email receipts for the charge. This will be null until a receipt is sent.

receipt_url
STRING

refunded
BOOLEAN

Indicates if the charge has been fully refunded. If the charge is only partially refunded, this attribute will be false.

refunds
ARRAY

A list of refunds that have been applied to the charge.

Click to expand refunds

value
STRING

The ID of the refund.
charges (table), refunds (attribute)

review
STRING

The ID of the review associated with the charge.

shipping
OBJECT

The shipping information for the charge.

Click to expand shipping

address
OBJECT

The shipping address.

Click to expand address

city
STRING

The city of the shipping address.

country
STRING

The two-letter country code of the shipping address. For example: us

line1
STRING

The first address line of the shipping address.

line2
STRING

The second address line of the shipping address.

postal_code
STRING

The zip or postal code of the shipping address.

state
STRING

The state, county, province, region, etc. of the shipping address
charges (table), address (attribute)

carrier
STRING

The delivery service that shipped a physical product. For example: FedEx

name
STRING

The recipient’s name.

phone
STRING

The recipient’s phone number, including extension.

tracking_number
STRING

The tracking number for a physical product, obtained from the delivery service (carrier).
charges (table), shipping (attribute)

source
OBJECT

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

Click to expand source

id
STRING

The card ID.

Reference:

address_city
STRING

The city associated with the card’s billing address.

address_country
STRING

The billing address country.

address_line1
STRING

The first line of the billing address.

address_line1_check
STRING

If address_line1 was provided, the results of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

address_line2
STRING

The second line of the billing address.

address_state
STRING

The state/county/province/region of the billing address.

address_zip
STRING

The zip or postal code of the billing address.

address_zip_check
STRING

If address_zip was provided, the results of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

brand
STRING

The brand of the card. Possible values are:

  • American Express
  • Diners Club
  • Discover
  • JCB
  • MasterCard
  • UnionPay
  • Visa
  • Unknown

country
STRING

The two-letter ISO code representing the country of the card.

customer
STRING

The ID of the customer that the card belongs to.

Reference:

cvc_check
STRING

If a CVC was provided, this will be the result of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

dynamic_last4
STRING

For tokenized numbers only. The last four digits of the device account number.

exp_month
INTEGER

The two-digit number representing the card’s expiration month.

exp_year
INTEGER

The four-digit number representing the card’s expiration year.

fingerprint
STRING

A unique ID for the card number.

funding
STRING

The card’s funding type. Possible values are:

  • credit
  • debit
  • prepaid
  • unknown

last4
STRING

The last four digits of the card.

metadata
OBJECT

Additional information attached to the card.

Click to expand metadata

ANYTHING
ANYTHING

This info will vary.
charges (table), metadata (attribute)

name
STRING

The name of the cardholder.

object
STRING

The type of Stripe object. This will be card.

tokenization_method
STRING

If the card number is tokenized, this is the method that was used. Possible values are:

  • apple_pay
  • android_pay
charges (table), source (attribute)

source_transfer
STRING

The transfer ID that created the charge. Only present if the charge came from another Stripe account.

Reference:

statement_description
STRING

Deprecated by Stripe.

statement_descriptor
STRING

Additional information about the charge. This appears on the customer’s credit card statement.

statement_descriptor_suffix
STRING

status
STRING

The status of the payment. Possible values are:

  • succeeded
  • pending
  • failed

transfer_data
OBJECT

Click to expand transfer_data

amount
INTEGER

destination
STRING

charges (table), transfer_data (attribute)

transfer_group
STRING

A string that identifies this transaction as part of a group.

updated
DATE-TIME

The time at which the charge was last updated.

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

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

amount_off
INTEGER

The amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.

currency
STRING

The three-letter ISO currency code of the amount to take off (amount_off).

duration
STRING

Indicates how long a customer who applies this coupon will get the discount. Possible values are:

  • forever
  • once
  • repeating

duration_in_months
INTEGER

Indicates the number of months the coupon applies if duration: repeating.

livemode
BOOLEAN

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

max_redemptions
INTEGER

The maximum number of times this coupon can be redeemed in total across all customers before it is no longer valid.

metadata
OBJECT

Click to expand metadata

ANYTHING
ANYTHING

This info will vary.
coupons (table), metadata (attribute)

name
STRING

The name of the coupon as it is displayed to customers.

object
STRING

The type of Stripe object. This will be coupon.

percent_off
NUMBER

The percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.

percent_off_precise
NUMBER

redeem_by
DATE-TIME

The date after which the coupon can no longer be redeemed.

times_redeemed
INTEGER

The number of times this coupon has been applied to a customer.

updated
DATE-TIME

The time at which the coupon was last updated.

valid
BOOLEAN

Taking into account all of the other coupon properties, indicates whether this coupon can still be applied to a customer.

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:

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

created
DATE-TIME

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

account_balance
INTEGER

The current balance, if any, being stored on the customer’s account.

cards
ARRAY

Details about the customer’s cards.

Click to expand cards

id
STRING

The card ID.

Reference:

address_city
STRING

The city associated with the card’s billing address.

address_country
STRING

The billing address country.

address_line1
STRING

The first line of the billing address.

address_line1_check
STRING

If address_line1 was provided, the results of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

address_line2
STRING

The second line of the billing address.

address_state
STRING

The state/county/province/region of the billing address.

address_zip
STRING

The zip or postal code of the billing address.

address_zip_check
STRING

If address_zip was provided, the results of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

brand
STRING

The brand of the card. Possible values are:

  • American Express
  • Diners Club
  • Discover
  • JCB
  • MasterCard
  • UnionPay
  • Visa
  • Unknown

country
STRING

The two-letter ISO code representing the country of the card.

customer
STRING

The ID of the customer that the card belongs to.

Reference:

cvc_check
STRING

If a CVC was provided, this will be the result of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

dynamic_last4
STRING

For tokenized numbers only. The last four digits of the device account number.

exp_month
INTEGER

The two-digit number representing the card’s expiration month.

exp_year
INTEGER

The four-digit number representing the card’s expiration year.

fingerprint
STRING

A unique ID for the card number.

funding
STRING

The card’s funding type. Possible values are:

  • credit
  • debit
  • prepaid
  • unknown

last4
STRING

The last four digits of the card.

metadata
OBJECT

Additional information attached to the card.

Click to expand metadata

ANYTHING
ANYTHING

This info will vary.
customers (table), metadata (attribute)

name
STRING

The name of the cardholder.

object
STRING

The type of Stripe object. This will be card.

tokenization_method
STRING

If the card number is tokenized, this is the method that was used. Possible values are:

  • apple_pay
  • android_pay
customers (table), cards (attribute)

currency
STRING

The three-letter ISO currency code the customer can be charged in for recurring billing purposes.

default_card
STRING

default_source
STRING

The ID of the default source attached to this customer.

delinquent
BOOLEAN

When the customer’s latest invoice is billed by charging automatically, this will be true if the invoice’s latest charge failed.

When the customer’s latest invoice is billed by sending an invoice, this will be true if the invoice is not paid by its due date.

description
STRING

The description of the customer.

discount
OBJECT

Describes the current discount active on the customer.

Click to expand discount

coupon
OBJECT

Details about the coupon applied to the customer.

Click to expand coupon

id
STRING

The coupon ID.

Reference:

amount_off
INTEGER

The amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.

created
DATE-TIME

currency
STRING

The three-letter ISO currency code of the amount to take off (amount_off).

duration
STRING

Indicates how long a customer who applies this coupon will get the discount. Possible values are:

  • forever
  • once
  • repeating

duration_in_months
INTEGER

Indicates the number of months the coupon applies if duration: repeating.

livemode
BOOLEAN

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

max_redemptions
INTEGER

The maximum number of times this coupon can be redeemed in total across all customers before it is no longer valid.

metadata
OBJECT

Click to expand metadata

ANYTHING
ANYTHING

This info will vary.
customers (table), metadata (attribute)

name
STRING

The name of the coupon as it is displayed to customers.

object
STRING

The type of Stripe object. This will be coupon.

percent_off
INTEGER

The percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.

percent_off_precise
NUMBER

redeem_by
DATE-TIME

The date afer which the coupon can no longer be redeemed.

times_redeemed
INTEGER

The number of times this coupon has been applied to a customer.

valid
BOOLEAN

Taking into account all of the other coupon properties, indicates whether this coupon can still be applied to a customer.
customers (table), coupon (attribute)

customer
STRING

The ID of the customer the discount applies to.

Reference:

end
DATE-TIME

If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.

object
STRING

The type of Stripe object. This will be discount.

start
DATE-TIME

Date that the coupon was applied.

subscription
STRING

The subscription that this coupon is applied to, if it is applied to a particular subscription.

Reference:

customers (table), discount (attribute)

discounts
ARRAY

Click to expand discounts

value
STRING

customers (table), discounts (attribute)

email
STRING

The customer’s email address.

invoice_prefix
STRING

The prefix used to generate unique invoice numbers for the customer.

invoice_settings
OBJECT

Click to expand invoice_settings

custom_fields
ARRAY

Click to expand custom_fields

value
STRING

customers (table), custom_fields (attribute)

default_payment_method
STRING

footer
STRING

customers (table), invoice_settings (attribute)

livemode
BOOLEAN

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

name
STRING

metadata
OBJECT

Click to expand metadata

ANYTHING
ANYTHING

This info will vary.
customers (table), metadata (attribute)

next_invoice_sequence
INTEGER

object
STRING

The type of Stripe object. This will be customer.

phone
STRING

preferred_locales
ARRAY

Click to expand preferred_locales

value
STRING

customers (table), preferred_locales (attribute)

shipping
OBJECT

Mailing and shipping addresses for the customer. Appears on invoices emailed to this customer.

Click to expand shipping

address
OBJECT

Click to expand address

city
STRING

The city of the shipping address.

country
STRING

The two-letter country code of the shipping address. For example: us

line1
STRING

The first address line of the shipping address.

line2
STRING

The second address line of the shipping address.

postal_code
STRING

The zip or postal code of the shipping address.

state
STRING

The state, county, province, region, etc. of the shipping address
customers (table), address (attribute)

name
STRING

The recipient’s name.

phone
STRING

The recipient’s phone number, including extension.
customers (table), shipping (attribute)

sources
ARRAY

The customer’s payment sources.

Click to expand sources

ach_credit_transfer
OBJECT

If the source is an ACH credit transfer, this will contain the details about the ACH credit transfer source.

Click to expand ach_credit_transfer

account_number
STRING

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1`, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready.

bank_name
STRING

The name of the bank the credit transfer should be sent to.

fingerprint
STRING

refund_account_holder_name
STRING

refund_account_holder_type
STRING

refund_account_number
STRING

refund_routing_number
STRING

routing_number
STRING

The routing number of the bank receiving the credit transfer.

swift_code
STRING

customers (table), ach_credit_transfer (attribute)

address_city
STRING

The city associated with the card’s billing address.

address_country
STRING

The billing address country.

address_line1
STRING

The first line of the billing address.

address_line1_check
STRING

If address_line1 was provided, the results of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

address_line2
STRING

The second line of the billing address.

address_state
STRING

The state/county/province/region of the billing address.

address_zip
STRING

The zip or postal code of the billing address.

address_zip_check
STRING

If address_zip was provided, the results of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

alipay

If the source is an Alipay source, this will contain the details about the Alipay source.

amount
INTEGER

bancontact

If the source is a Bancontact source, this will contain the details about the Bancontact source.

brand
STRING

The brand of the card. Possible values are:

  • American Express
  • Diners Club
  • Discover
  • JCB
  • MasterCard
  • UnionPay
  • Visa
  • Unknown

card
OBJECT

If the source is a card source, this will contain the details about the card source.

Click to expand card

id
STRING

The card ID.

address_city
STRING

The city associated with the card’s billing address.

address_country
STRING

The billing address country.

address_line1
STRING

The first line of the billing address.

address_line1_check
STRING

If address_line1 was provided, the results of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

address_line2
STRING

The second line of the billing address.

address_state
STRING

The state/county/province/region of the billing address.

address_zip
STRING

The zip or postal code of the billing address.

address_zip_check
STRING

If address_zip was provided, the results of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

brand
STRING

The brand of the card. Possible values are:

  • American Express
  • Diners Club
  • Discover
  • JCB
  • MasterCard
  • UnionPay
  • Visa
  • Unknown

country
STRING

The two-letter ISO code representing the country of the card.

customer
STRING

The ID of the customer that the card belongs to.

Reference:

cvc_check
STRING

If a CVC was provided, this will be the result of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

dynamic_last4
STRING

For tokenized numbers only. The last four digits of the device account number.

exp_month
INTEGER

The two-digit number representing the card’s expiration month.

exp_year
INTEGER

The four-digit number representing the card’s expiration year.

fingerprint
STRING

A unique ID for the card number.

funding
STRING

The card’s funding type. Possible values are:

  • credit
  • debit
  • prepaid
  • unknown

last4
STRING

The last four digits of the card.

metadata
OBJECT

Additional information attached to the card.

Click to expand metadata

ANYTHING
ANYTHING

This info will vary.
customers (table), metadata (attribute)

name
STRING

The name of the cardholder.

object
STRING

The type of Stripe object. This will be card.

tokenization_method
STRING

If the card number is tokenized, this is the method that was used. Possible values are:

  • apple_pay
  • android_pay
customers (table), card (attribute)

client_secret
STRING

The client secret of the source. Used for client-side retrieval using a publishable key.

country
STRING

The two-letter ISO code representing the country of the card.

created
DATE-TIME

The time the source was created.

currency
STRING

The three-letter ISO currency code associated with the source.

customer
STRING

The ID of the customer to which the source is attached.

cvc_check
STRING

If a CVC was provided, this will be the result of the check. Possible values are:

  • pass
  • fail
  • unavailable
  • unchecked

dynamic_last4
STRING

For tokenized numbers only. The last four digits of the device account number.

eps

If the source is an EPS source, this will contain the details about the EPS source.

exp_month
INTEGER

The two-digit number representing the card’s expiration month.

exp_year
INTEGER

The four-digit number representing the card’s expiration year.

fingerprint
STRING

A unique ID for the card number.

flow
STRING

The authentication flow of the source. Possible values are:

  • redirect
  • receiver
  • code_verification
  • none

funding
STRING

The card’s funding type. Possible values are:

  • credit
  • debit
  • prepaid
  • unknown

id
STRING

The source ID.

ideal
OBJECT

If the source is an iDEAL source, this will contain the details about the iDEAL source.

last4
STRING

The last four digits of the card.

livemode
BOOLEAN

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

metadata
OBJECT

Click to expand metadata

ANYTHING
ANYTHING

This info will vary.
customers (table), metadata (attribute)

multibanco
OBJECT

name
STRING

The name of the cardholder.

object
STRING

The type of Stripe object. This will be source.

owner
OBJECT

Details about the owner of the payment instrument that may be used or required by particular source types.

Click to expand owner

address
OBJECT

The owner’s address.

Click to expand address

city
STRING

The city of the owner’s address.

country
STRING

The country of the owner’s address.

line1
STRING

The first line of the owner’s address.

line2
STRING

The second line of the owner’s address.

postal_code
STRING

The postal code of the owner’s address.

state
STRING

The state of the owner’s address.
customers (table), address (attribute)

email
STRING

The owner’s email address.

name
STRING

The owner’s full name.

phone
STRING

The owner’s phone number.

verified_address
STRING

The verified owner’s address. Verified values are verified or provided by the payment directly at the time of authorization or settlement.

verified_email
STRING

The verified owner’s email address. Verified values are verified or provided by the payment directly at the time of authorization or settlement.

verified_name
STRING

The verified owner’s full name. Verified values are verified or provided by the payment directly at the time of authorization or settlement.

verified_phone
STRING

The verified owner’s phone number. Verified values are verified or provided by the payment directly at the time of authorization or settlement.
customers (table), owner (attribute)

receiver
OBJECT

Information related to the receiver flow. These attributes will be present if flow: receiver.

Click to expand receiver

address
STRING

The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.

amount_charged
INTEGER

The total amount charged by you, expressed in the source’s currency.

amount_received
INTEGER

The total amount received by the receiver source, expressed in the source’s currency.

amount_returned
INTEGER

The total amount returned to the customer, expressed in the source’s currency.

refund_attributes_method
STRING

refund_attributes_status
STRING

customers (table), receiver (attribute)

redirect
OBJECT

Information related to the redirect flow. These attributes will be present if flow: redirect.

Click to expand redirect

failure_reason
STRING

The failure reason for the redirect. Possible values are:

  • user_abort - The customer aborted or dropped out of the redirect flow
  • declined - The authentication failed or the transaction was declined
  • processing_error - The redirect failed due to a technical error; only present if the redirect status is failed.

return_url
STRING

The URL you provide to redirect the customer to after they authenticate their payment.

status
STRING

The status of the redirect. Possible values are:

  • pending - Ready to be used by your customer to authenticate the transaction
  • succeeded - Successful authentication; cannot be reused
  • not_required - Redirect should not be used
  • failed - Failed authentication; cannot be reused

url
STRING

The URL provided to you to redirect a customer as part of a redirect authentication flow.
customers (table), redirect (attribute)

statement_descriptor
STRING

Extra information about a source. This will appear on your customer’s statement every time you charge the source.

status
STRING

The status of the source. Possible values are:

  • canceled
  • chargeable
  • consumed
  • failed
  • pending

tokenization_method
STRING

If the card number is tokenized, this is the method that was used. Possible values are:

  • apple_pay
  • android_pay

type
STRING

The type of the source. Possible values are:

  • ach_credit_transfer
  • ach_debit
  • alipay
  • bancontact
  • card
  • card_present
  • eps
  • giropay
  • ideal
  • multibanco
  • p24
  • paper_check
  • sepa_credit_transfer
  • sepa_debit
  • sofort
  • three_d_secure

usage
STRING

Indicates if the source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. Possible values are:

  • reusable
  • single_use
customers (table), sources (attribute)

subscriptions
ARRAY

The customer’s current subscriptions.

tax_info
STRING

tax_info_verification
STRING

tax_exempt
STRING

tax_rates
ARRAY

Click to expand tax_rates

active
BOOLEAN

country
STRING

created
DATE-TIME

description
STRING

display_name
STRING

id
STRING

inclusive
BOOLEAN

jurisdiction
STRING

livemode
BOOLEAN

object
STRING

percentage
DECIMAL

state
STRING

customers (table), tax_rates (attribute)

unit_amount_decimal
DECIMAL

updated
DATE-TIME

The time at which the customer was last updated.

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

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

amount
INTEGER

The disputed amount of money.

balance_transactions
ARRAY

A list of zero, one, or two balance transactions that show funds withdrawn and reinstated to a Stripe account as a result of the dispute.

charge
STRING

The ID of the disputed charge.

Reference:

currency
STRING

The three-letter ISO currency code of the disputed charge.

evidence
OBJECT

Click to expand evidence

access_activity_log
STRING

Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product.

billing_address
STRING

The billing address provided by the customer.

cancellation_policy
STRING

The subscription cancellation policy, as shown to the customer.

cancellation_policy_disclosure
STRING

The explanation of how and when the customer was shown the refund policy prior to purchase.

cancellation_rebuttal
STRING

The justification for why the customer’s subscription was not canceled.

customer_communication
STRING

Any communication with the customer that is relevant to your case.

customer_email_address
STRING

The email address of the customer.

customer_name
STRING

The name of the customer.

customer_purchase_ip
STRING

The IP address that the customer used when making the purchase.

customer_signature
STRING

A relevant document or contract showing the customer’s signature.

duplicate_charge_documentation
STRING

Documentation for the prior charge that can uniquely identify the charge.

duplicate_charge_explanation
STRING

The explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.

duplicate_charge_id
STRING

The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.

product_description
STRING

The description of the product or service that was sold.

receipt
STRING

The receipt or message sent to the customer notifying them of the charge.

refund_policy
STRING

The refund policy, as shown to the customer.

refund_policy_disclosure
STRING

Documentation demonstrating that the customer was shown your refund policy prior to purchase.

refund_refusal_explanation
STRING

The justification for why the customer is not entitled to a refund.

service_date
STRING

The date on which the customer received or began receiving the purchased service.

service_documentation
STRING

Documentation showing proof that a service was provided to the customer.

shipping_address
STRING

The address to which a physical product was shipped.

shipping_carrier
STRING

The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

shipping_date
STRING

The date on which a physical product began its route to the shipping address.

shipping_documentation
STRING

Documentation showing proof that a product was shipped to the customer at the same address the customer provided.

shipping_tracking_number
STRING

The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated, these will be comma-delineated.

uncategorized_file
STRING

Any additional evidence or statements.

uncategorized_text
STRING

Any additional evidence or statements.
disputes (table), evidence (attribute)

evidence_details
OBJECT

Information about the evidence submitted.

Click to expand evidence_details

due_by
DATE-TIME

The date by which evidence must be submitted in order to successfully challenge dispute.

has_evidence
BOOLEAN

Whether or not evidence has been staged for the dispute.

past_due
BOOLEAN

Whether the last evidence submission was submitted past the due date.

submission_count
INTEGER

The number of times evidence has been submitted.
disputes (table), evidence_details (attribute)

is_charge_refundable
BOOLEAN

Whether or not the disputed charge is refundable.

livemode
BOOLEAN

Has the value TRUE if the object exists in live mode or the value FALSE if the object exists in test mode.

metadata
OBJECT

A set of key-value pairs that you can attach to an object.

object
STRING

The object type. In this table, the value is dispute.

reason
STRING

The reason given by the cardholder for the dispute. Possible values are:

  • bank_cannot_process
  • check_returned
  • credit_not_processed
  • customer_initiated
  • debit_not_authorized
  • duplicate
  • fraudulent
  • general
  • incorrect_account_details
  • insufficient_funds
  • product_not_received
  • product_unacceptable
  • subscription_canceled
  • unrecognized

status
STRING

The current status of the dispute. Possible values are:

  • warning_needs_response
  • warning_under_review
  • warning_closed
  • needs_response
  • under_review
  • charge_refunded
  • won
  • lost

updated
DATE-TIME

The time at which the dispute was last updated.

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

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

data

This object contains details about the event, relevant to the event’s type.

For example: For an invoice.* event, this will be a full invoice object. Refer to the object’s dedicated table (ex: invoices) for a list of possible attributes.

Note: To join specific events with the corresponding object record, this attribute must be set to replicate. It contains the object’s id, which is necessary to join events to objects correctly.

livemode
BOOLEAN

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

object
STRING

The type of Stripe object. This will be event.

pending_webhooks
INTEGER

The number of webhooks that have yet to be successfully delivered to the URLs you’ve specified.

request
STRING

The info on the API request that triggered the event.

type
STRING

The description of the event. For example: invoice.created

updated
DATE-TIME

The time at which the object was last updated.

invoices

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

date
Primary Key :

id

 API endpoint :

List all invoices

The invoices table contains info about invoices. Invoices are statements of amounts owed by customers, which can be one-off charges or generated periodically from a subscription.

Invoice line items

Full records for the line items associated with an invoice can be found in the invoice_line_items table. To replicate these records, you must set this table and the invoice_line_items table to replicate.

invoices table schema

id
STRING

The invoice ID.

Reference:

account_name
STRING

account_tax_ids
ARRAY

Click to expand account_tax_ids

value
STRING

invoices (table), account_tax_ids (attribute)

date
DATE-TIME

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

amount_due
INTEGER

The final amount due at the time of the invoice.

amount_paid
INTEGER

The amount (in cents) that was paid.

amount_remaining
INTEGER

The amount remaining (in cents) that is due.

application_fee
INTEGER

The fee (in cents) that will be applied to the invoice and transfered to the application owner’s Stripe account when the invoice is paid.

attempt_count
INTEGER

The number of payment attempts made for this invoice, from the perspective of the payment retry schedule.

attempted
BOOLEAN

Indicates whether an attempt has been made to pay the invoice.

auto_advance
BOOLEAN

Indicates whether Stripe will perform automatic collection of the invoice.

billing
STRING

The type of billing action performed by Stripe to pay the invoice. Possible values are:

  • charge_automatically - Stripe will attempt to pay the invoice using the default source attached to the customer.
  • send_invoice - Stripe will email this invoice to the customer with payment instructions.

billing_reason
STRING

Indicates why the invoice was created. Possible values are:

  • subscription_cycle - Indicates an invoice was created by a subscription advancing into a new period.
  • subscription_update - Indicates an invoice was created due to creating or updating a subscription.
  • subscription - Set for all old invoices to indicate either a change to a subscription or a period advancement.
  • manual - Set for all invoices unrelated to a subscription.
  • upcoming - Reserved for simulated invoices.

charge
STRING

The ID of the latest charge generated for this invoice.

Reference:

closed
BOOLEAN

Deprecated by Stripe.

collection_method
STRING

created
INTEGER

currency
STRING

The three-letter ISO currency code.

customer
STRING

The ID of the customer associated with the invoice.

Reference:

customer_address
OBJECT

Click to expand customer_address

city
STRING

country
STRING

line1
STRING

line2
STRING

postal_code
STRING

state
STRING

invoices (table), customer_address (attribute)

customer_email
STRING

customer_name
STRING

customer_phone
STRING

customer_shipping
OBJECT

Click to expand customer_shipping

address
OBJECT

Click to expand address

city
STRING

country
STRING

line1
STRING

line2
STRING

postal_code
STRING

state
STRING

invoices (table), address (attribute)

name
STRING

phone
STRING

invoices (table), customer_shipping (attribute)

customer_tax_ids
ARRAY

Click to expand customer_tax_ids

type
STRING

value
STRING

invoices (table), customer_tax_ids (attribute)

customer_tax_exempt
STRING

date
DATE-TIME

default_payment_method
STRING

default_source
STRING

default_tax_rates
ARRAY

Click to expand default_tax_rates

active
BOOLEAN

country