Stripe snapshot

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

STITCH
Release Status

Released

Supported By

Stitch

Stitch Plan

Free

Singer GitHub Repository

Stripe Repository

DATA SELECTION
Table Selection

Supported

Column Selection

Supported

REPLICATION SETTINGS
Anchor Scheduling

Supported

Table-level Reset

Unsupported

Configurable Replication Methods

Unsupported

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 sync

The Sync Historical Data setting will define the starting date for your Stripe integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

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.

Stitch offers two methods of creating a replication schedule:

  • Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
  • Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:

    • A Replication Frequency of at least one hour is required to use anchor scheduling.
    • An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

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 tables and columns to replicate

To complete the setup, you’ll need to select the tables and columns you want to replicate to your data warehouse.

Check out the Schema section to learn more about the available tables in Stripe and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A green 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.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

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

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 schemas

balance_transactions

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.

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.

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

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.


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.

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

balance_transaction
STRING

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

Reference:

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.

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.

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

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.

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.


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.

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.

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.

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.

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.

address
OBJECT

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

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.

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.

status
STRING

The status of the payment. Possible values are:

  • succeeded
  • pending
  • failed

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.


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.

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

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


Replication Method :

Key-based Incremental

Replication Key :

created

Primary Key :

id

API endpoint :

List all customers

The customers table contains info about your customers.

id
STRING

The customer ID.

Reference:

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.

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.

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.

coupon
OBJECT

Details about the coupon applied to the customer.

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

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)

email
STRING

The customer’s email address.

invoice_prefix
STRING

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

livemode
BOOLEAN

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

metadata
OBJECT

ANYTHING
ANYTHING

This info will vary.

customers (table), metadata (attribute)

object
STRING

The type of Stripe object. This will be customer.

shipping
OBJECT

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

address
OBJECT

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.

ach_credit_transfer
OBJECT

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

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.

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.

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

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.

address
OBJECT

The owner’s 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.

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.

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

updated
DATE-TIME

The time at which the customer was last updated.


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.

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.


Replication Method :

Key-based Incremental

Replication Key :

date

Primary Key :

id

API endpoint :

List all invoice items

The invoice_items table contains info about items contained in customer invoices.

id
STRING

The invoice item ID.

Reference:

date
DATE-TIME

The date the invoice item was added to the invoice.

amount
INTEGER

The amount (in the currency specified_ of the invoice item. This is equal to unit_amount * quantity.

currency
STRING

The three-letter ISO currency code, in lowercase.

customer
STRING

The ID of the customer who will be billed for the invoice item.

Reference:

description
STRING

A description of the invoice item.

discountable
BOOLEAN

Indicates if discounts will apply to the invoice item (true). This will always be false for prorations.

invoice
STRING

The ID of the invoice associated with the invoice item.

Reference:

livemode
BOOLEAN

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

metadata
OBJECT

Additional information attached to the invoice item.

ANYTHING
ANYTHING

This info will vary.

invoice_items (table), metadata (attribute)

object
STRING

The type of Stripe object. This will be invoiceitem.

period
OBJECT

The start and end dates of the period associated with the invoice item.

end
DATE-TIME

The time the period ends.

start
DATE-TIME

The time the period starts.

invoice_items (table), period (attribute)

plan
OBJECT

If the invoice item is a proration, this will contain details about the plan of the subscription the proration was computed for.

active
BOOLEAN

Indicates if the plan is currently available for new subscriptions.

aggregate_usage
STRING

Indicates a usage aggregation strategy for plans of usage_type: metered. Possible values are:

  • sum - Sums up all usage during a period
  • last_during_period - Selects the last usage record reported within a period
  • last_ever - Selects the last usage record ever (across period bounds)
  • max - Selects the usage record with the maximum reported usage during a period

amount
INTEGER

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

billing_scheme
STRING

Indicates how the price per period should be computed. Possible values are:

  • per_unit - Indicates that the fixed amount will be charged per unit (quantity) for plans with usage_type: licensed, or per unit of total usage for plans with usage_type: metered.
  • tiered - Indicates that unit pricing will be computed using a tiering strategy as defined using tiers and tiers_mode.

created
DATE-TIME

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

currency
STRING

The three-letter ISO currency code, in lowercase.

id
STRING

The plan ID.

Reference:

interval
STRING

The frequency with which a subscription should be billed. Possible values are day, week, month, or year.

interval_count
INTEGER

The number of intervals (specified by interval) between subscription billings.

For example: interval: month and interval_count: 3 would bill every three months.

livemode
BOOLEAN

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

metadata
OBJECT

Additional information attached to the plan.

ANYTHING
ANYTHING

This info will vary.

invoice_items (table), metadata (attribute)

nickname
STRING

A brief description of the plan, not visible to customers.

object
STRING

The type of Stripe object. This will be plan.

product
STRING

The product whose pricing this plan determines.

tiers
ARRAY

The pricing tiers associated with the plan.

value
INTEGER

The pricing tier.

invoice_items (table), tiers (attribute)

tiers_mode
STRING

Indicates if the pricing tier should be graduated or volume- based.

  • volume - The maximum quantity within a period determines the per unit price
  • graduated - Pricing can successively change as the quantity grows

transform_usage
STRING

Applies a transformation to the reported usage or set quantity before computing the billed price.

trial_period_days
INTEGER

The default number of trial days when subscribing a customer to this plan.

usage_type
STRING

Indicates how the quantity per period should be determined. Possible values are:

  • metered - Aggregates total usage based on usage records.
  • licensed - Automtaically bills the quantity set for a plan when it’s added to a subscription.
invoice_items (table), plan (attribute)

proration
BOOLEAN

Indicates whether the invoice item was created automatically as a proration adjustment when the customer switched plans.

quantity
INTEGER

The quantity of units for the invoice item.

If the invoice item is a proration, the quantity of the subscription that the proration was computed for.

subscription
STRING

The subscription that this invoice item was created for.

Reference:

subscription_item
STRING

The subscription item associated with the invoice item.

Reference:

unit_amount
INTEGER

The unity amount (in the currency specified) of the invoice item.

updated
DATE-TIME

Time at which the object was last updated.


invoice_line_items

Replication Method :

Key-based Incremental

Replication Key :

created

Primary Key :

id

API endpoint :

Retrieve an invoice’s line items

The invoice_line_items table contains info about the line items contained in invoices.

Note: In order to replicate invoice line item data, the invoices table must also be set to replicate.

Invoice line item replication

To replicate invoice line items, Stitch will use the Replication Key of the corresponding invoice in the invoices table to detect new and updated records. This means that any time an invoice is updated, its associated line items will also be replicated.

For example: An invoice with five line items is updated when its status changes from draft to open. The record in invoices will be replicated, as will the records for its five line items. In this example, a total of six records will be replicated.

id
STRING

The invoice line item ID.

Reference:

created
DATE-TIME

Time at which the parent invoice was created. Measured in seconds since the Unix epoch. Refer to table notes for additional details.

amount
INTEGER

The amount (in cents) of the charge to be applied to the upcoming invoice.

currency
STRING

The three-letter ISO currency code.

description
STRING

An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.

discountable
BOOLEAN

Indicates whether discounts can apply to this line item.

invoice
STRING

The ID of the invoice that contains this line item.

Reference:

invoice_item
STRING

The invoice item(s) associated with this invoice line item.

Reference:

livemode
BOOLEAN

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

metadata
OBJECT

Additional information attached to the invoice line item.

ANYTHING
ANYTHING

This info will vary.

invoice_line_items (table), metadata (attribute)

object
STRING

The type of Stripe object. This will be charge.

period
OBJECT

The start and end dates of the period associated with the invoice line item.

end
DATE-TIME

The time the period ended.

start
DATE-TIME

The time the period started.

invoice_line_items (table), period (attribute)

plan
OBJECT

If the invoice line item is a proration, this will contain details about the plan of the subscription the proration was computed for.

active
BOOLEAN

Indicates if the plan is currently available for new subscriptions.

aggregate_usage
STRING

Indicates a usage aggregation strategy for plans of usage_type: metered. Possible values are:

  • sum - Sums up all usage during a period
  • last_during_period - Selects the last usage record reported within a period
  • last_ever - Selects the last usage record ever (across period bounds)
  • max - Selects the usage record with the maximum reported usage during a period

amount
INTEGER

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

billing_scheme
STRING

Indicates how the price per period should be computed. Possible values are:

  • per_unit - Indicates that the fixed amount will be charged per unit (quantity) for plans with usage_type: licensed, or per unit of total usage for plans with usage_type: metered.
  • tiered - Indicates that unit pricing will be computed using a tiering strategy as defined using tiers and tiers_mode.

created
DATE-TIME

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

currency
STRING

The three-letter ISO currency code, in lowercase.

id
STRING

The plan ID.

Reference:

interval
STRING

The frequency with which a subscription should be billed. Possible values are day, week, month, or year.

interval_count
INTEGER

The number of intervals (specified by interval) between subscription billings.

For example: interval: month and interval_count: 3 would bill every three months.

livemode
BOOLEAN

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

metadata
OBJECT

Additional information attached to the plan.

ANYTHING
ANYTHING

This info will vary.

invoice_line_items (table), metadata (attribute)

nickname
STRING

A brief description of the plan, not visible to customers.

object
STRING

The type of Stripe object. This will be plan.

product
STRING

The product whose pricing this plan determines.

tiers
ARRAY

The pricing tiers associated with the plan.

value
INTEGER

The pricing tier.

invoice_line_items (table), tiers (attribute)

tiers_mode
STRING

Indicates if the pricing tier should be graduated or volume- based.

  • volume - The maximum quantity within a period determines the per unit price
  • graduated - Pricing can successively change as the quantity grows

transform_usage
STRING

Applies a transformation to the reported usage or set quantity before computing the billed price.

trial_period_days
INTEGER

The default number of trial days when subscribing a customer to this plan.

usage_type
STRING

Indicates how the quantity per period should be determined. Possible values are:

  • metered - Aggregates total usage based on usage records.
  • licensed - Automtaically bills the quantity set for a plan when it’s added to a subscription.
invoice_line_items (table), plan (attribute)

proration
BOOLEAN

Indicates if the invoice line item is a proration.

quantity
INTEGER

The quantity of units for the invoice line item.

subscription
STRING

The ID of the subscription associated with the invoice line item.

Reference:

subscription_item
STRING

The subscription item associated with the invoice line item.

Reference:

type
STRING

The type of the invoice line item.


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.

id
STRING

The invoice ID.

Reference:

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.

currency
STRING

The three-letter ISO currency code.

customer
STRING

The ID of the customer associated with the invoice.

Reference:

description
STRING

A description of the invoice.

discount
OBJECT

Describes the current discount active on the invoice.

coupon
OBJECT

Details about the coupon applied to the invoice.

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

ANYTHING
ANYTHING

This info will vary.

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

invoices (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:

invoices (table), discount (attribute)

due_date
DATE-TIME

The date on which payment for the invoice is due.

ending_balance
INTEGER

The ending customer balance after the invoice is finalized.

forgiven
BOOLEAN

hosted_invoice_url
STRING

The URL for the hosted invoice page, which allows customers to view and pay the invoice.

invoice_pdf
STRING

The link to download the PDF for the invoice.

lines
ARRAY

The IDs of the line items that make up the invoice. Full details for these records are in the invoice_line_items table.

value
STRING

The ID of the line item.

Reference:

invoices (table), lines (attribute)

livemode
BOOLEAN

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

metadata
OBJECT

Additional information attached to the invoice.

ANYTHING
ANYTHING

This info will vary.

invoices (table), metadata (attribute)

next_payment_attempt
DATE-TIME

The time at which the next payment will be attempted.

number
STRING

A unique ID that appears on email sent to the customer for the invoice. This value begins with the customer’s unique invoice_prefix, if specified.

object
STRING

The type of Stripe object. This will be invoice.

paid
BOOLEAN

Indicates whether payment was successfully collected for this invoice.

payment
STRING

period_end
DATE-TIME

The end of the usage period during which invoice items were added to this invoice.

period_start
DATE-TIME

The start of the usage period during which invoice items were added to this invoice.

receipt_number
STRING

The transaction number that appears on email receipts sent for this invoice.

starting_balance
INTEGER

The starting customer balance before the invoice is finalized.

statement_description
STRING

Deprecated by Stripe.

statement_descriptor
STRING

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

subscription
STRING

The ID that the invoice was prepared for.

Reference:

subtotal
INTEGER

The total of all subscriptions, invoice items, and prorations on the invoice before any discount is applied.

tax
INTEGER

The amount of tax included in the total, calculated from tax_percent and the subtotal.

tax_percent
NUMBER

The percentage of the subtotal that has been added to the total amount of the invoice, including invoice line items and discounts. This field is inheirited from the subscription’s tax_percent attribute.

total
INTEGER

The total of the invoice after any discounts.

updated
DATE-TIME

The time the invoice was last updated.

webhooks_delivered_at
DATE-TIME

The time at which webhooks for this invoice were successfully delivered.


Replication Method :

Key-based Incremental

Replication Key :

created

Primary Key :

id

API endpoint :

List all payouts

The payouts table contains info about payouts, which occur when you receive funds from Stripe or initiate a payout to a bank account of the debit card of a connected Stripe account.

id
STRING

The payout ID.

created
DATE-TIME

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

amount
INTEGER

The amount (in cents) to be transferred to your bank account or debit card.

amount_reversed
INTEGER

arrival_date
DATE-TIME

The date the payout is expected to arrive in the bank.

automatic
BOOLEAN

Indicates if the payout was created by an automated payout schedule (true) or if it was requested manually (false).

balance_transaction
STRING

The ID of the balance transaction that describes the impact of this payout on your account balance.

Reference:

bank_account
OBJECT

Details about the bank account the payout is being sent to.

account_holder_name
STRING

The name of the person or business that owns the bank account.

account_holder_type
STRING

The type of entity that holds the account. Possible values are individual or company.

bank_name
STRING

The name of the bank associated with the routing number. For example: WELLS FARGO

country
STRING

The two-letter ISO code representing the country the bank account is located in.

currency
STRING

The three-letter ISO code for the currency paid out to the bank account.

fingerprint
STRING

Uniquely identifies the bank account.

id
STRING

The bank account ID in Stripe.

last4
STRING

The last four digits associated with the bank account.

metadata
OBJECT

name
STRING

Deprecated by Stripe.

object
STRING

The type of Stripe object. This will be bank_account.

routing_number
STRING

The routing transit number for the bank account.

status
STRING

The status of the bank account. Possible values are:

  • new - Indicates the bank account hasn’t been validated or had any activity.
  • validated - Indicates that Stripe has determined the bank account exists.
  • verified - Indicates that bank account verification has succeeded.
  • verification_failed - Indicates that verfication failed.
  • errored - Indicates that a transfer sent to the bank account failed. Transfers will not be sent to the account until its details are updated.
payouts (table), bank_account (attribute)

currency
STRING

The three-letter ISO currency code.

date
DATE-TIME

description
STRING

The description of the payout.

destination
STRING

The ID of the bank account of card the payout was sent to.

failure_balance_transaction
STRING

If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.

Reference:

failure_code
STRING

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

failure_message
STRING

The message displaying to the user that further explains the reason for payout failure.

livemode
BOOLEAN

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

metadata
OBJECT

ANYTHING
ANYTHING

This info will vary.

payouts (table), metadata (attribute)

method
STRING

The method used to send the payout. Possible values are:

  • standard
  • instant

object
STRING

The type of Stripe object. This will be payout.

recipient
STRING

source_transaction
STRING

The ID of the charge or payment used to fund the payout.

source_type
STRING

The source balance the payout came from. Possible values are:

  • card
  • bank_account
  • alipay_account

statement_description
STRING

Deprecated by Stripe.

statement_descriptor
STRING

Additional info about a payout to be displayed on the user’s bank statement.

status
STRING

The status of the payout. Possible values are:

  • paid
  • pending
  • in_transit
  • canceled
  • failed

transfer_group
STRING

A string that identifies the payout as part of a group.

type
STRING

The type of the payout. Possible values are bank_account or card.

updated
DATE-TIME

The time the payout was last updated.


Replication Method :

Key-based Incremental

Replication Key :

created

Primary Key :

id

API endpoint :

List all plans

The plans table contains info about the plans in your Stripe account. A plan defines the base price, currency, and billing cycle for subscriptions.

id
STRING

The plan ID.

Reference:

created
DATE-TIME

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

active
BOOLEAN

Indicates whether the plan is currently availble for new subscriptions.

aggregate_usage
STRING

Indicates a usage aggregation strategy for plans of usage_type: metered. Possible values are:

  • sum - Sums up all usage during a period
  • last_during_period - Selects the last usage record reported within a period
  • last_ever - Selects the last usage record ever (across period bounds)
  • max - Selects the usage record with the maximum reported usage during a period

amount
INTEGER

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

billing_scheme
STRING

Indicates how the price per period should be computed. Possible values are:

  • per_unit - Indicates that the fixed amount will be charged per unit (quantity) for plans with usage_type: licensed, or per unit of total usage for plans with usage_type: metered.
  • tiered - Indicates that unit pricing will be computed using a tiering strategy as defined using tiers and tiers_mode.

currency
STRING

The three-letter ISO currency code.

interval
STRING

The frequency with which a subscription should be billed. Possible values are day, week, month, or year.

interval_count
INTEGER

The number of intervals (specified by interval) between subscription billings.

For example: interval: month and interval_count: 3 would bill every three months.

livemode
BOOLEAN

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

metadata
OBJECT

ANYTHING
ANYTHING

This info will vary.

plans (table), metadata (attribute)

name
STRING

Deprecated by Stripe.

nickname
STRING

A brief description of the plan, not visible to customers.

object
STRING

The type of Stripe object. This will be plan.

product
STRING

The product whose pricing this plan determines.

statement_description
STRING

Deprecated by Stripe.

statement_descriptor
STRING

Extra information about a plan. This will appear on your customer’s credit card statement.

tiers
ARRAY

The pricing tiers associated with the plan.

value
INTEGER

The pricing tier.

plans (table), tiers (attribute)

tiers_mode
STRING

Indicates if the pricing tier should be graduated or volume- based.

  • volume - The maximum quantity within a period determines the per unit price
  • graduated - Pricing can successively change as the quantity grows

transform_usage
STRING

Applies a transformation to the reported usage or set quantity before computing the billed price.

trial_period_days
INTEGER

The default number of trial days when subscribing a customer to this plan.

updated
DATE-TIME

The time the plan was last updated.

usage_type
STRING

Indicates how the quantity per period should be determined. Possible values are:

  • metered - Aggregates total usage based on usage records.
  • licensed - Automtaically bills the quantity set for a plan when it’s added to a subscription.

subscription_items

Replication Method :

Key-based Incremental

Replication Key :

created

Primary Key :

id

API endpoint :

List subscription items

The subscription_items table contains info about subscription items. In Stripe, subscription items are used to create customer subscriptions with more than one plan.

id
STRING

The subscription item ID.

Reference:

created
DATE-TIME

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

application_fee_percent
NUMBER

The percentage Stripe should take off the final invoice amount each billing period.

cancel_at_period_end
BOOLEAN

Indicates if the subscription item is canceled at period end.

canceled_at
DATE-TIME

The date the subscription was canceled.

current_period_end
DATE-TIME

The time the current usage period is set to end.

current_period_start
DATE-TIME

The time the current usage period started.

customer
STRING

The customer ID.

Reference:

discount
OBJECT

Describes the current discount active on the subscription item.

coupon
OBJECT

Details about the coupon applied to the subscription item.

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

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

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

ANYTHING
ANYTHING

This info will vary.

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

subscription_items (table), coupon (attribute)
subscription_items (table), discount (attribute)

ended_at
DATE-TIME

If the subscription has ended, the date the subscription ended.

livemode
BOOLEAN

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

metadata
OBJECT

ANYTHING
ANYTHING

This info will vary.

subscription_items (table), metadata (attribute)

object
STRING

The type of Stripe object. This will be subscription_item.

plan
OBJECT

Details about the plan the customer subscribed to.

active
BOOLEAN

Indicates if the plan is currently available for new subscriptions.

aggregate_usage
STRING

Indicates a usage aggregation strategy for plans of usage_type: metered. Possible values are:

  • sum - Sums up all usage during a period
  • last_during_period - Selects the last usage record reported within a period
  • last_ever - Selects the last usage record ever (across period bounds)
  • max - Selects the usage record with the maximum reported usage during a period

amount
INTEGER

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

billing_scheme
STRING

Indicates how the price per period should be computed. Possible values are:

  • per_unit - Indicates that the fixed amount will be charged per unit (quantity) for plans with usage_type: licensed, or per unit of total usage for plans with usage_type: metered.
  • tiered - Indicates that unit pricing will be computed using a tiering strategy as defined using tiers and tiers_mode.

created
DATE-TIME

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

currency
STRING

The three-letter ISO currency code, in lowercase.

id
STRING

The plan ID.

Reference:

interval
STRING

The frequency with which a subscription should be billed. Possible values are day, week, month, or year.

interval_count
INTEGER

The number of intervals (specified by interval) between subscription billings.

For example: interval: month and interval_count: 3 would bill every three months.

livemode
BOOLEAN

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

metadata
OBJECT

Additional information attached to the plan.

ANYTHING
ANYTHING

This info will vary.

subscription_items (table), metadata (attribute)

nickname
STRING

A brief description of the plan, not visible to customers.

object
STRING

The type of Stripe object. This will be plan.

product
STRING

The product whose pricing this plan determines.

tiers
ARRAY

The pricing tiers associated with the plan.

value
INTEGER

The pricing tier.

subscription_items (table), tiers (attribute)

tiers_mode
STRING

Indicates if the pricing tier should be graduated or volume- based.

  • volume - The maximum quantity within a period determines the per unit price
  • graduated - Pricing can successively change as the quantity grows

transform_usage
STRING

Applies a transformation to the reported usage or set quantity before computing the billed price.

trial_period_days
INTEGER

The default number of trial days when subscribing a customer to this plan.

usage_type
STRING

Indicates how the quantity per period should be determined. Possible values are:

  • metered - Aggregates total usage based on usage records.
  • licensed - Automtaically bills the quantity set for a plan when it’s added to a subscription.
subscription_items (table), plan (attribute)

quantity
INTEGER

The quantity of the plan to which the subscription should be subscribed.

start
DATE-TIME

The date the most recent update to this subscription started.

status
STRING

The status of the subscription. Possible values are:

  • trialing - The subscription is still in its trial period
  • active - The subscription is active and no longer in its trial period
  • past_due - The subscription is past due, either because payment to renew has failed or the subscription’s invoice’s due date has passed.
  • canceled - The subscription has been canceled. This status may also occur when:
    • A subscription is past_due and Stripe has exhausted all payment retry attempts
    • A subscription is past_due and an invoice is sent and not paid by its due date, or an additional deadline after the original due date.
  • unpaid - The subscription is unpaid.

subscription
STRING

The ID of the subscription the subscription item belongs to.

Reference: