This integration is powered by Singer's Stripe tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
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.0) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release Status |
Released |
Supported By | |
| Stitch Plan |
Free |
Singer GitHub Repository | |
| DATA SELECTION | |||
| Table Selection |
Supported |
Column Selection |
Supported |
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Unsupported |
| 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
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Stripe icon.
-
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_stripein 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.
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
- Next, you’ll be prompted to sign into your Stripe account.
- 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.
- Click Sign in with Stripe to connect.
- Sign into your Stripe account.
- After the authorization process is successfully completed, you’ll be directed back to Stitch.
- 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.
- 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.
-
To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A green checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- 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.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
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
drafttoopen.
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.
Stripe table schemas
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1.0 of this integration.
This is the latest version of the Stripe integraiton.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
balance_transactions
| Replication Method : |
Key-based Incremental |
Replication Key  :
|
created |
Primary Key  :
|
id |
API endpoint : |
The balance_transactions table contains info about transactions have have contributed to your Stripe account balance, including charges, transfers, etc.
|
id
The balance transaction ID. Reference: |
|||||
|
created
The time at which the object was created. Measured in seconds since the Unix epoch. |
|||||
|
amount
The gross amount of the transaction, in cents. |
|||||
|
available_on
The date the transaction’s net funds will become available in the Stripe balance. |
|||||
|
currency
The three-letter ISO currency code. |
|||||
|
description
An arbitrary string attached to the object. Often useful for displaying to users. |
|||||
|
exchange_rate
The exchange rate for the |
|||||
|
fee
The fees (in cents) paid for this transaction. |
|||||
|
fee_details
Detailed breakdown of fees (in cents) paid for this transaction.
|
|||||
|
net
Net amount of the transaction, in cents. |
|||||
|
object
The type of Stripe object. This will be |
|||||
|
source
The Stripe object to which this transaction is related. |
|||||
|
sourced_transfers
|
|||||
|
status
Indicates if the transaction’s net funds are available in the Stripe. Possible values are |
|||||
|
type
The type of the transaction. Refer to Stripe’s documentation for a list of possible values. |
|||||
|
updated
The time at which the balance transaction was last updated. |
charges
| Replication Method : |
Key-based Incremental |
Replication Key :
|
created |
|
Primary Key :
|
id |
API endpoint : |
The charges table contains info about charges to credit and debit cards.
|
id
The charge ID. Reference: |
||||||||||||||||||||||||
|
created
Time at which the object was created. Measured in seconds since the Unix epoch. |
||||||||||||||||||||||||
|
amount
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
Amount in cents refunded (can be less than |
||||||||||||||||||||||||
|
application
The ID of the Connect application that created the charge. |
||||||||||||||||||||||||
|
application_fee
The application fee (if any) for the charge. |
||||||||||||||||||||||||
|
balance_transaction
The ID of the balance transaction that describes the impact of this charge on the Stripe account. Reference: |
||||||||||||||||||||||||
|
captured
If the charge was created without capturing, this attribute will indicate whether it’s still uncaptured or has since been captured. |
||||||||||||||||||||||||
|
card
Details about the credit or debit card that is the source of the charge.
|
||||||||||||||||||||||||
|
currency
The three-letter ISO currency code. |
||||||||||||||||||||||||
|
customer
The ID of the customer associated with the charge. Reference: |
||||||||||||||||||||||||
|
description
An arbitrary string attached to the object. Often useful for displaying to users. |
||||||||||||||||||||||||
|
destination
The account (if any) the charge was made on behalf of, with an automatic transfer. |
||||||||||||||||||||||||
|
dispute
Details about the dispute, if the charge has been dispuated. |
||||||||||||||||||||||||
|
failure_code
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
The message that displays to the user that further explains the reason for the charge failure. |
||||||||||||||||||||||||
|
fraud_details
Details about fraud assessments for the charge.
|
||||||||||||||||||||||||
|
invoice
The ID of the invoice the charge is for. Reference: |
||||||||||||||||||||||||
|
livemode
Indicates if the object exists in live mode ( |
||||||||||||||||||||||||
|
metadata
Additional information attached to the charge. |
||||||||||||||||||||||||
|
object
The type of Stripe object. This will be |
||||||||||||||||||||||||
|
on_behalf_of
The account the charge was made on behalf of without triggering an automatic transfer. |
||||||||||||||||||||||||
|
order
The ID of the order this charge is for. |
||||||||||||||||||||||||
|
outcome
Details about whether the payment was accepted and why.
|
||||||||||||||||||||||||
|
paid
Indicates if the charge succeeded ( |
||||||||||||||||||||||||
|
payment_intent
The ID of the payment intent associated with the charge. |
||||||||||||||||||||||||
|
receipt_email
The email address that the receipt for the charge was sent to. |
||||||||||||||||||||||||
|
receipt_number
The transaction number that appears on email receipts for the charge. This will be |
||||||||||||||||||||||||
|
refunded
Indicates if the charge has been fully refunded. If the charge is only partially refunded, this attribute will be |
||||||||||||||||||||||||
|
refunds
A list of refunds that have been applied to the charge. |
||||||||||||||||||||||||
|
review
The ID of the review associated with the charge. |
||||||||||||||||||||||||
|
shipping
The shipping information for the charge.
|
||||||||||||||||||||||||
|
source
Details about the credit or debit card that is the source of the charge.
|
||||||||||||||||||||||||
|
source_transfer
The transfer ID that created the charge. Only present if the charge came from another Stripe account. Reference: |
||||||||||||||||||||||||
|
statement_description
Deprecated by Stripe. |
||||||||||||||||||||||||
|
statement_descriptor
Additional information about the charge. This appears on the customer’s credit card statement. |
||||||||||||||||||||||||
|
status
The status of the payment. Possible values are:
|
||||||||||||||||||||||||
|
transfer_group
A string that identifies this transaction as part of a group. |
||||||||||||||||||||||||
|
updated
The time at which the charge was last updated. |
coupons
| Replication Method : |
Key-based Incremental |
Replication Key :
|
created |
|
Primary Key :
|
id |
API endpoint : |
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
The coupon ID. Reference: |
|
|
created
Time at which the object was created. Measured in seconds since the Unix epoch. |
|
|
amount_off
The amount (in the |
|
|
currency
The three-letter ISO currency code of the amount to take off ( |
|
|
duration
Indicates how long a customer who applies this coupon will get the discount. Possible values are:
|
|
|
duration_in_months
Indicates the number of months the coupon applies if |
|
|
livemode
Indicates if the coupon exists in live mode ( |
|
|
max_redemptions
The maximum number of times this coupon can be redeemed in total across all customers before it is no longer valid. |
|
|
metadata
|
|
|
name
The name of the coupon as it is displayed to customers. |
|
|
object
The type of Stripe object. This will be |
|
|
percent_off
The percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. |
|
|
percent_off_precise
|
|
|
redeem_by
The date afer which the coupon can no longer be redeemed. |
|
|
times_redeemed
The number of times this coupon has been applied to a customer. |
|
|
updated
The time at which the coupon was last updated. |
|
|
valid
Taking into account all of the other coupon properties, indicates whether this coupon can still be applied to a customer. |
customers
| Replication Method : |
Key-based Incremental |
Replication Key :
|
created |
|
Primary Key :
|
id |
API endpoint : |
The customers table contains info about your customers.
|
id
The customer ID. Reference: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
created
Time at which the object was created. Measured in seconds since the Unix epoch. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
account_balance
The current balance, if any, being stored on the customer’s account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cards
Details about the customer’s cards.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currency
The three-letter ISO currency code the customer can be charged in for recurring billing purposes. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
default_card
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
default_source
The ID of the default source attached to this customer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
delinquent
When the customer’s latest invoice is billed by charging automatically, this will be When the customer’s latest invoice is billed by sending an invoice, this will be |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
description
The description of the customer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
discount
Describes the current discount active on the customer.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
email
The customer’s email address. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
invoice_prefix
The prefix used to generate unique invoice numbers for the customer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
livemode
Indicates if the customer exists in live mode ( |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
metadata
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
object
The type of Stripe object. This will be |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
shipping
Mailing and shipping addresses for the customer. Appears on invoices emailed to this customer.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sources
The customer’s payment sources.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subscriptions
The customer’s current subscriptions.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tax_info
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tax_info_verification
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
updated
The time at which the customer was last updated. |
events
| Replication Method : |
Key-based Incremental |
Replication Key :
|
created |
|
Primary Key :
|
id |
API endpoint : |
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
The event ID. Reference: |
|
created
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 For example: For an Note: To join specific events with the corresponding object record, this attribute must be set to replicate. It contains the object’s |
|
livemode
Indicates if the object exists in live mode ( |
|
object
The type of Stripe object. This will be |
|
pending_webhooks
The number of webhooks that have yet to be successfully delivered to the URLs you’ve specified. |
|
request
The info on the API request that triggered the event. |
|
type
The description of the event. For example: |
|
updated
The time at which the object was last updated. |
invoice_items
| Replication Method : |
Key-based Incremental |
Replication Key :
|
date |
|
Primary Key :
|
id |
API endpoint : |
The invoice_items table contains info about items contained in customer invoices.
|
id
The invoice item ID. Reference: |
||||||||||||||||||||
|
date
The date the invoice item was added to the invoice. |
||||||||||||||||||||
|
amount
The amount (in the |
||||||||||||||||||||
|
currency
The three-letter ISO currency code, in lowercase. |
||||||||||||||||||||
|
customer
The ID of the customer who will be billed for the invoice item. Reference: |
||||||||||||||||||||
|
description
A description of the invoice item. |
||||||||||||||||||||
|
discountable
Indicates if discounts will apply to the invoice item ( |
||||||||||||||||||||
|
invoice
The ID of the invoice associated with the invoice item. Reference: |
||||||||||||||||||||
|
livemode
Indicates if the object exists in live mode ( |
||||||||||||||||||||
|
metadata
Additional information attached to the invoice item.
|
||||||||||||||||||||
|
object
The type of Stripe object. This will be |
||||||||||||||||||||
|
period
The start and end dates of the period associated with the invoice item.
|
||||||||||||||||||||
|
plan
If the invoice item is a proration, this will contain details about the plan of the subscription the proration was computed for.
|
||||||||||||||||||||
|
proration
Indicates whether the invoice item was created automatically as a proration adjustment when the customer switched plans. |
||||||||||||||||||||
|
quantity
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
The subscription that this invoice item was created for. Reference: |
||||||||||||||||||||
|
subscription_item
The subscription item associated with the invoice item. Reference: |
||||||||||||||||||||
|
unit_amount
The unity amount (in the |
||||||||||||||||||||
|
updated
Time at which the object was last updated. |
invoice_line_items
| Replication Method : |
Key-based Incremental |
Replication Key :
|
created |
|
Primary Key :
|
id |
API endpoint : |
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
The invoice line item ID. Reference: |
||||||||||||||||||||
|
created
Time at which the parent invoice was created. Measured in seconds since the Unix epoch. Refer to table notes for additional details. |
||||||||||||||||||||
|
amount
The amount (in cents) of the charge to be applied to the upcoming invoice. |
||||||||||||||||||||
|
currency
The three-letter ISO currency code. |
||||||||||||||||||||
|
description
An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. |
||||||||||||||||||||
|
discountable
Indicates whether discounts can apply to this line item. |
||||||||||||||||||||
|
invoice
The ID of the invoice that contains this line item. Reference: |
||||||||||||||||||||
|
invoice_item
The invoice item(s) associated with this invoice line item. Reference: |
||||||||||||||||||||
|
livemode
Indicates if the object exists in live mode ( |
||||||||||||||||||||
|
metadata
Additional information attached to the invoice line item.
|
||||||||||||||||||||
|
object
The type of Stripe object. This will be |
||||||||||||||||||||
|
period
The start and end dates of the period associated with the invoice line item.
|
||||||||||||||||||||
|
plan
If the invoice line item is a proration, this will contain details about the plan of the subscription the proration was computed for.
|
||||||||||||||||||||
|
proration
Indicates if the invoice line item is a proration. |
||||||||||||||||||||
|
quantity
The quantity of units for the invoice line item. |
||||||||||||||||||||
|
subscription
The ID of the subscription associated with the invoice line item. Reference: |
||||||||||||||||||||
|
subscription_item
The subscription item associated with the invoice line item. Reference: |
||||||||||||||||||||
|
type
The type of the invoice line item. |
invoices
| Replication Method : |
Key-based Incremental |
Replication Key :
|
date |
|
Primary Key :
|
id |
API endpoint : |
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
The invoice ID. Reference: |
|||||||||||||||||||||||
|
date
The time at which the invoice was created. Measured in seconds since the Unix epoch. |
|||||||||||||||||||||||
|
amount_due
The final amount due at the time of the invoice. |
|||||||||||||||||||||||
|
amount_paid
The amount (in cents) that was paid. |
|||||||||||||||||||||||
|
amount_remaining
The amount remaining (in cents) that is due. |
|||||||||||||||||||||||
|
application_fee
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
The number of payment attempts made for this invoice, from the perspective of the payment retry schedule. |
|||||||||||||||||||||||
|
attempted
Indicates whether an attempt has been made to pay the invoice. |
|||||||||||||||||||||||
|
auto_advance
Indicates whether Stripe will perform automatic collection of the invoice. |
|||||||||||||||||||||||
|
billing
The type of billing action performed by Stripe to pay the invoice. Possible values are:
|
|||||||||||||||||||||||
|
billing_reason
Indicates why the invoice was created. Possible values are:
|
|||||||||||||||||||||||
|
charge
The ID of the latest charge generated for this invoice. Reference: |
|||||||||||||||||||||||
|
closed
Deprecated by Stripe. |
|||||||||||||||||||||||
|
currency
The three-letter ISO currency code. |
|||||||||||||||||||||||
|
customer
The ID of the customer associated with the invoice. Reference: |
|||||||||||||||||||||||
|
description
A description of the invoice. |
|||||||||||||||||||||||
|
discount
Describes the current discount active on the invoice.
|
|||||||||||||||||||||||
|
due_date
The date on which payment for the invoice is due. |
|||||||||||||||||||||||
|
ending_balance
The ending customer balance after the invoice is finalized. |
|||||||||||||||||||||||
|
forgiven
|
|||||||||||||||||||||||
|
hosted_invoice_url
The URL for the hosted invoice page, which allows customers to view and pay the invoice. |
|||||||||||||||||||||||
|
invoice_pdf
The link to download the PDF for the invoice. |
|||||||||||||||||||||||
|
lines
The IDs of the line items that make up the invoice. Full details for these records are in the
|
|||||||||||||||||||||||
|
livemode
Indicates if the object exists in live mode ( |
|||||||||||||||||||||||
|
metadata
Additional information attached to the invoice.
|
|||||||||||||||||||||||
|
next_payment_attempt
The time at which the next payment will be attempted. |
|||||||||||||||||||||||
|
number
A unique ID that appears on email sent to the customer for the invoice. This value begins with the customer’s unique |
|||||||||||||||||||||||
|
object
The type of Stripe object. This will be |
|||||||||||||||||||||||
|
paid
Indicates whether payment was successfully collected for this invoice. |
|||||||||||||||||||||||
|
payment
|
|||||||||||||||||||||||
|
period_end
The end of the usage period during which invoice items were added to this invoice. |
|||||||||||||||||||||||
|
period_start
The start of the usage period during which invoice items were added to this invoice. |
|||||||||||||||||||||||
|
receipt_number
The transaction number that appears on email receipts sent for this invoice. |
|||||||||||||||||||||||
|
starting_balance
The starting customer balance before the invoice is finalized. |
|||||||||||||||||||||||
|
statement_description
Deprecated by Stripe. |
|||||||||||||||||||||||
|
statement_descriptor
Additional information about the invoice. This appears on the customer’s credit card statement. |
|||||||||||||||||||||||
|
subscription
The ID that the invoice was prepared for. Reference: |
|||||||||||||||||||||||
|
subtotal
The total of all subscriptions, invoice items, and prorations on the invoice before any discount is applied. |
|||||||||||||||||||||||
|
tax
The amount of tax included in the total, calculated from |
|||||||||||||||||||||||
|
tax_percent
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 |
|||||||||||||||||||||||
|
total
The total of the invoice after any discounts. |
|||||||||||||||||||||||
|
updated
The time the invoice was last updated. |
|||||||||||||||||||||||
|
webhooks_delivered_at
The time at which webhooks for this invoice were successfully delivered. |
payouts
| Replication Method : |
Key-based Incremental |
Replication Key :
|
created |
|
Primary Key :
|
id |
API endpoint : |
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
The payout ID. |
|||||||||||||
|
created
The time at which the payout was created. Measured in seconds since the Unix epoch. |
|||||||||||||
|
amount
The amount (in cents) to be transferred to your bank account or debit card. |
|||||||||||||
|
amount_reversed
|
|||||||||||||
|
arrival_date
The date the payout is expected to arrive in the bank. |
|||||||||||||
|
automatic
Indicates if the payout was created by an automated payout schedule ( |
|||||||||||||
|
balance_transaction
The ID of the balance transaction that describes the impact of this payout on your account balance. Reference: |
|||||||||||||
|
bank_account
Details about the bank account the payout is being sent to.
|
|||||||||||||
|
currency
The three-letter ISO currency code. |
|||||||||||||
|
date
|
|||||||||||||
|
description
The description of the payout. |
|||||||||||||
|
destination
The ID of the bank account of card the payout was sent to. |
|||||||||||||
|
failure_balance_transaction
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
The error code explaining the reason for payout failure. Refer to Stripe’s documentation for a list of possible codes. |
|||||||||||||
|
failure_message
The message displaying to the user that further explains the reason for payout failure. |
|||||||||||||
|
livemode
Indicates if the object exists in live mode ( |
|||||||||||||
|
metadata
|
|||||||||||||
|
method
The method used to send the payout. Possible values are:
|
|||||||||||||
|
object
The type of Stripe object. This will be |
|||||||||||||
|
recipient
|
|||||||||||||
|
source_transaction
The ID of the charge or payment used to fund the payout. |
|||||||||||||
|
source_type
The source balance the payout came from. Possible values are:
|
|||||||||||||
|
statement_description
Deprecated by Stripe. |
|||||||||||||
|
statement_descriptor
Additional info about a payout to be displayed on the user’s bank statement. |
|||||||||||||
|
status
The status of the payout. Possible values are:
|
|||||||||||||
|
transfer_group
A string that identifies the payout as part of a group. |
|||||||||||||
|
type
The type of the payout. Possible values are |
|||||||||||||
|
updated
The time the payout was last updated. |
| Replication Method : |
Key-based Incremental |
Replication Key :
|
created |
|
Primary Key :
|
id |
API endpoint : |
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
The plan ID. Reference: |
|
created
Time at which the plan was created. Measured in seconds since the Unix epoch. |
|
active
Indicates whether the plan is currently availble for new subscriptions. |
|
aggregate_usage
Indicates a usage aggregation strategy for plans of
|
|
amount
The amount (in cents) to be charged on the interval specified. |
|
billing_scheme
Indicates how the price per period should be computed. Possible values are:
|
|
currency
The three-letter ISO currency code. |
|
interval
The frequency with which a subscription should be billed. Possible values are |
|
interval_count
The number of intervals (specified by For example: |
|
livemode
Indicates if the object exists in live mode ( |
|
metadata
|
|
name
Deprecated by Stripe. |
|
nickname
A brief description of the plan, not visible to customers. |
|
object
The type of Stripe object. This will be |
|
product
The product whose pricing this plan determines. |
|
statement_description
Deprecated by Stripe. |
|
statement_descriptor
Extra information about a plan. This will appear on your customer’s credit card statement. |
|
tiers
The pricing tiers associated with the plan. |
|
tiers_mode
Indicates if the pricing tier should be
|
|
transform_usage
Applies a transformation to the reported usage or set quantity before computing the billed price. |
|
trial_period_days
The default number of trial days when subscribing a customer to this plan. |
|
updated
The time the plan was last updated. |
|
usage_type
Indicates how the quantity per period should be determined. Possible values are:
|
subscription_items
| Replication Method : |
Key-based Incremental |
Replication Key :
|
created |
|
Primary Key :
|
id |
API endpoint : |
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
The subscription item ID. Reference: |
||||||||||||||||||||
|
created
The time at which the subscription item was created. Measured in seconds since the Unix epoch. |
||||||||||||||||||||
|
application_fee_percent
The percentage Stripe should take off the final invoice amount each billing period. |
||||||||||||||||||||
|
cancel_at_period_end
Indicates if the subscription item is canceled at period end. |
||||||||||||||||||||
|
canceled_at
The date the subscription was canceled. |
||||||||||||||||||||
|
current_period_end
The time the current usage period is set to end. |
||||||||||||||||||||
|
current_period_start
The time the current usage period started. |
||||||||||||||||||||
|
customer
The customer ID. Reference: |
||||||||||||||||||||
|
discount
Describes the current discount active on the subscription item.
|
||||||||||||||||||||
|
ended_at
If the subscription has ended, the date the subscription ended. |
||||||||||||||||||||
|
livemode
Indicates if the object exists in live mode ( |
||||||||||||||||||||
|
metadata
|
||||||||||||||||||||
|
object
The type of Stripe object. This will be |
||||||||||||||||||||
|
plan
Details about the plan the customer subscribed to.
|
||||||||||||||||||||
|
quantity
The quantity of the plan to which the subscription should be subscribed. |
||||||||||||||||||||
|
start
The date the most recent update to this subscription started. |
||||||||||||||||||||
|
status
The status of the subscription. Possible values are:
|
||||||||||||||||||||
|
subscription
The ID of the subscription the subscription item belongs to. Reference: |
||||||||||||||||||||
|
tax_percent
The tax rate applied to each invoice created by this subscription. |
||||||||||||||||||||
|
trial_end
The time the trial associated with the subscription item ends. |
||||||||||||||||||||
|
trial_start
The time the trial associated with the subscription item started. |
subscriptions
| Replication Method : |
Key-based Incremental |
Replication Key :
|
created |
|
Primary Key :
|
id |
API endpoint : |
The subscriptions table contains info about subscriptions, which allow you to charge a customer on a recurring basis. A subscription ties a customer to a particular plan.
|
id
The subscription ID. Reference: |
||||||||||||||||||||
|
created
The time the subscription was created. Measured in second since the Unix epoch. |
||||||||||||||||||||
|
application_fee_percent
The percentage of the subscription invoice subtotal that will be transferred to the application owner’s Stripe account. This value will be a decimal between |
||||||||||||||||||||
|
billing
The type of billing action performed by Stripe to pay the invoice. Possible values are:
|
||||||||||||||||||||
|
billing_cycle_anchor
Indicates the date of the first full invoice. With plans with |
||||||||||||||||||||
|
cancel_at_period_end
If the subscription has been canceled with |
||||||||||||||||||||
|
canceled_at
The date the subscription was canceled. |
||||||||||||||||||||
|
current_period_end
The end of the current period that the subscription has been invoiced for. |
||||||||||||||||||||
|
current_period_start
The start of the current period that the subscription has been invoiced for. |
||||||||||||||||||||
|
customer
THe ID of the customer who owns the subscription. Reference: |
||||||||||||||||||||
|
days_until_due
The number of days a customer has to pay invoices generated by the subscription. |
||||||||||||||||||||
|
discount
Describes the current discount active on the subscription.
|
||||||||||||||||||||
|
ended_at
If the subscription has ended, the date the subscription ended. |
||||||||||||||||||||
|
items
The subscription items associated with the subscription.
|
||||||||||||||||||||
|
livemode
Indicates if the object exists in live mode ( |
||||||||||||||||||||
|
metadata
|
||||||||||||||||||||
|
object
The type of Stripe object. This will be |
||||||||||||||||||||
|
plan
Details about the plan the customer subscribed to.
|
||||||||||||||||||||
|
quantity
The quantity of the plan to w hich the customer is subscribed. For example: If a plan is $20/user/month, and a customer has 5 users, the this value would be |
||||||||||||||||||||
|
start
The date the subscription was last updated. |
||||||||||||||||||||
|
status
The status of the subscription. Possible values are:
|
||||||||||||||||||||
|
tax_percent
The tax rate applied to the subscription. |
||||||||||||||||||||
|
trial_end
If the subscription has a trial, the end of the trial. |
||||||||||||||||||||
|
trial_start
If the subscription has a trial, the start of the trial. |
||||||||||||||||||||
|
updated
The time the subscription was last updated. |
transfers
| Replication Method : |
Key-based Incremental |
Replication Key :
|
created |
|
Primary Key :
|
id |
API endpoint : |
The transfers table contains info about transfers sent to connected accounts.
|
id
The transfer ID. Reference: |
|
|
created
The time the transfer was created. Measured in seconds since the Unix epoch. |
|
|
amount
The amount (in cents) to be transferred. |
|
|
amount_reversed
The amount (in cents) reversed. |
|
|
arrival_date
The date the transfer arrived. |
|
|
automatic
|
|
|
balance_transaction
The ID of the balance transaction that describes the impact of the transfer on your account balance. Reference: |
|
|
currency
The three-letter ISO code of the currency the transfer is in. |
|
|
date
|
|
|
description
The description of the transfer. |
|
|
destination
The ID of the Stripe account the transfer was sent to. |
|
|
failure_balance_transaction
If the transfer 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: |
|
|
livemode
Indicates if the object exists in live mode ( |
|
|
metadata
|
|
|
object
The type of Stripe object. This will be |
|
|
recipient
|
|
|
reversed
Indicates whether the transfer has been fully reversed. If the transfer was only partially reversed, this will still be |
|
|
source_transaction
The ID of the charge or payment that was used to fund the transfer. |
|
|
source_type
The source balance the transfer came from. Possible values are:
|
|
|
statement_description
Deprecated by Stripe. |
|
|
statement_descriptor
Additional information that displays on the statment. |
|
|
transfer_group
A string that identifies the transfer as part of a group. |
|
|
updated
The time the transfer was last updated. |
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.