Links

Stripe

1. How to connect to Stripe?

You can follow the following steps to build a connection with your Stripe account.
1. Go to the Resources page and click the Add Resource button.
2. In the "Select a data source" step, select Stripe under Apps.
3. In the "Configure the data source" step, enter the following information:
  • Client Secret: your Stripe API key usually starts with "sk_live_". (Find your API here)
  • Account ID: your Stripe account ID starts with 'acct_'. (Find your account ID here)
4. In the "Select the tables" step, choose tables that you want to connect. See here for more details on each table.
5. Click Finish Setup. You will see a
icon next to your Stripe resource. It may take a few minutes to several hours depending on the data size and the number of your tables. Once your APP's data is ready, you will receive a notification email.

2. How to find Stripe API key and Account ID?

Secret API key

1. Go here and log into your Stripe account.
2. Find your secret key that usually starts with "sk_live_".

Account ID

  1. 1.
    Go here and log into your Stripe account.
  2. 2.
    At the top-right of the setting page, you can find your account ID that starts with "acct_" .

3. How to set up Data Sync?

Acho supports creating schedulers to retrieve the latest data from your Stripe account at a certain time interval. To see more details, you can visit here.

4. Available Data

For every third-party App integration, there are many tables that can be imported. Outside of the reference tables, here are some of the most used tables for your analytics.

Balance Transactions (Incremental)

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
Column Name
Type
Descripton
id
String
Unique identifier for the object.
amount
Integer
Gross amount of the transaction, in cents.
currency
String
Three-letter ISO currency code, in lowercase. Must be a supported currency.
description
String
An arbitrary string attached to the object. Often useful for displaying to users.
fee
Integer
Fees (in cents) paid for this transaction.
fee_details
Array
A detailed breakdown of fees (in cents) paid for this transaction.
net
Integer
Net amount of the transaction, in cents.
source
String
The Stripe object to which this transaction is related.
status
String
If the transaction’s net funds are available in the Stripe balance yet. Either available or pending.
type
String
Transaction type: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, payment, payment_failure_refund, payment_refund, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund. Learn more about balance transaction types and what they represent.
object
String
String representing the object’s type. Objects of the same type share the same value.
available_on
timestamp
The date the transaction’s net funds will become available in the Stripe balance.
created
Integer
Time at which the object was created. Measured in seconds since the Unix epoch.
exchange_rate
float
The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the amount in currency A, times exchange_rate, would be the amount in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent’s amount would be 1000 and currency would be eur. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction’s amount would be 1234, currency would be usd, and exchange_rate would be 1.234.

Bank accounts

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.
Column Names
Type
Description
id
String
Unique identifier for the object.
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. This can be either individual or company.
bank_name
String
Name of the bank associated with the routing number (e.g., WELLS FARGO).
country
String
Two-letter ISO code representing the country the bank account is located in.
currency
String
Three-letter ISO code for the currency paid out to the bank account.
customer
String
The ID of the customer that the bank account is associated with.
fingerprint
String
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
last4
String
The last four digits of the bank account number.
metadata
hah
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
routing_number
String
The routing transit number for the bank account.
object
String
String representing the object’s type. Objects of the same type share the same value.
status
String
For bank accounts, possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn’t had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a transfer sent to this bank account fails, we’ll set the status to errored and will not continue to send transfers until the bank details are updated.

Charges (Incremental)

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.
Column Names
Type
Description
id
String
Unique identifier for the object.
amount
Integer
Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
balance_transaction
String
ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
currency
String
Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer
String
The ID of the customer this charge is for if one exists.
description
String
An arbitrary string attached to the object. Often useful for displaying to users.
dispute
ID of the dispute associated with this charge if one exists.
invoice
String
The ID of the invoice this charge is for if one exists.
metadata
Hash
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
payment_intent
String
The ID of the PaymentIntent associated with this charge, if one exists.
payment_method_details
Hash
Details about the payment method at the time of the transaction.
receipt_email
String
This is the email address that the receipt for this charge was sent to.
refunded
Boolean
Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
shipping
Hash
Shipping information for the charge.
statement_descriptor
String
For card charges, use statement_descriptor_suffix instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
statement_descriptor_suffix
Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
status
String
The status of the payment is either succeeded, pending, or failed.
object
String
String representing the object’s type. Objects of the same type share the same value.
amount_refunded
Integer
Amount in bani refunded (can be less than the amount attribute on the charge if a partial refund was issued).
application
String
ID of the Connect application that created the charge.
application_fee
String
The application fee (if any) for the charge.
captured
Boolean
If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
created
Integer
Time at which the object was created. Measured in seconds since the Unix epoch.
failure_code
String
Error code explaining reason for charge failure if available (see the errors section for a list of codes).
failure_message
String
Message to user further explaining reason for charge failure if available.
fraud_details
Hash
Information on fraud assessments for the charge.
livemode
Boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
on_behalf_of
String
The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details.
order
String
ID of the order this charge is for if one exists.
outcome
Hash
Details about whether the payment was accepted, and why. See understanding declines for details.
paid
Boolean
True if the charge succeeded, or was successfully authorized for later capture.
receipt_number
String
This is the transaction number that appears on email receipts sent for this charge. This attribute will be null until a receipt has been sent.
refunds
List
A list of refunds that have been applied to the charge.
review
String
ID of the review associated with this charge if one exists.
source_transfer
String
transfer_group
String
A string that identifies this transaction as part of a group.

Coupons (Incremental)

Returns a list of your coupons.
Column Name
Type
Description
id
String
Unique identifier for the object.
amount_off
Integer
Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer. It's a positive integer.
currency
String
If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
duration
String
One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
duration_in_months
Integer
If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once. It's a positive integer or zero.
metadata
Hash
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
name
String
Name of the coupon displayed to customers on for instance invoices or receipts.
percent_off
Float
Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a £100 invoice £50 instead.
object
String
String representing the object’s type. Objects of the same type share the same value.
created
Integer
Time at which the object was created. Measured in seconds since the Unix epoch.
livemode
Boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
max_redemptions
Integer
Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. It's =a positive integer or zero.
redeem_by
timestamp
Date after which the coupon can no longer be redeemed.
times_redeemed
Integer
Number of times this coupon has been applied to a customer. It's a positive integer or zero.
valid
Boolean
Taking account of the above properties, whether this coupon can still be applied to a customer.

Customers (Incremental)

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
Column Name
Type
Description
id
String
Unique identifier for customers.
account_balance
address
Hash
The customer’s address.
cards
description
String
An arbitrary string attached to the object. Often useful for displaying to users.
email
String
The customer’s email address.
metadata
Hash
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
name
String
The customer’s full name or business name.
phone
String
The customer’s phone number.
shipping
Hash
Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
object
String
String representing the object’s type. Objects of the same type share the same value. The value is "customer".
balance
Integer
Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.
created
Integer
Time at which the object was created. Measured in seconds since the Unix epoch.
currency
String
Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.
default_source
String
ID of the default payment source for the customer.
delinquent
Boolean
When the customer’s latest invoice is billed by charging automatically, delinquent is true if the invoice’s latest charge failed. When the customer’s latest invoice is billed by sending an invoice, delinquent is true if the invoice isn’t paid by its due date. If an invoice is marked uncollectible by dunning, delinquent doesn’t get reset to false.
discount
Hash
Describes the current discount active on the customer, if there is one.
default_card
invoice_prefix
String
The prefix for the customer used to generate unique invoice numbers.
invoice_settings
Hash
The customer’s default invoice settings.
livemode
Boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
next_invoice_sequence
Integer
The suffix of the customer’s next invoice number, e.g., 0001.
preferred_locales
Array
The customer’s preferred locales (languages), ordered by preference.
sources
List
The customer’s payment sources, if any. This field is not included by default. To include it in the response, expand the sources field.
subscriptions
List
The customer’s current subscriptions, if any. This field is not included by default. To include it in the response, expand the subscriptions field.
tax_exempt
Hash
Describes the customer’s tax exemption status. One of none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the text “Reverse charge”.
tax_info
tax_info_verification

Customer Balance Transactions (Incremental)

Returns a list of transactions that updated the customer’s balances.
Column Name
Type
Description
id
String
Unique identifier for customer balance transactions.
amount
Integer
The amount of the transaction. A negative value is a credit for the customer’s balance, and a positive value is a debit to the customer’s balance.
currency
String
Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer
String
The ID of the customer the transaction belongs to.
description
String
An arbitrary string attached to the object. Often useful for displaying to users.
ending_balance
Integer
The customer’s balance after the transaction was applied. A negative value decreases the amount due on the customer’s next invoice. A positive value increases the amount due on the customer’s next invoice.
metadata
Hash
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
type
String
Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_too_large, invoice_too_small, unspent_receiver_credit, or unapplied_from_invoice.
object
String
String representing the object’s type. Objects of the same type share the same value. The value here is "customer_balance_transactions".
created
Integer
Time at which the object was created. Measured in seconds since the Unix epoch.
credit_note
String
The ID of the credit note (if any) related to the transaction.
invoice
String
The ID of the invoice (if any) related to the transaction.
livemode
Boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Disputes (Incremental)

Returns a list of your disputes.
Column Name
Type
Description
id
String
Unique identifier for disputes.
amount
Integer
Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).
charge
String
ID of the charge that was disputed.
currency
String
Three-letter ISO currency code, in lowercase. Must be a supported currency.
evidence
Hash
Evidence provided to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review.
metadata
Hash
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
reason
String
Reason given by cardholder for dispute. Possible values are bank_cannot_process, check_returned, credit_not_processed, customer_initiated, debit_not_authorized, duplicate, fraudulent, general, incorrect_account_details, insufficient_funds, product_not_received, product_unacceptable, subscription_canceled, or unrecognized.
status
String
Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost.
object
String
String representing the object’s type. Objects of the same type share the same value. The value here is "dispute".
balance_transactions
Array
List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute
created
Integer
Time at which the object was created. Measured in seconds since the Unix epoch.
evidence_details
Hash
Information about the evidence submission.
is_charge_refundable
Boolean
If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.
livemode
Boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Events (Incremental)

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).
Column Name
Type
Description
id
String
Unique identifier for the object.
api_version
String
The Stripe API version used to render data. Note: This property is populated only for events on or after October 31, 2014.
data
Hash
Object containing data associated with the event.
request
Hash
Information on the API request that instigated the event.
type
String
Description of the event (e.g., invoice.created or charge.refunded).
object
String
String representing the object’s type. Objects of the same type share the same value.
account
String
The connected account that originated the event.
created
Integer
Time at which the object was created. Measured in seconds since the Unix epoch.
livemode
Boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
pending_webhooks
Integer
Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you’ve specified. The value should be positive integer or zero.

Invoices (Incremental)

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
Column Name
Type
Description
id
String
Unique identifier for invoices.
amount_due
Integer
Final amount due at this time for this invoice. If the invoice’s total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
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 transferred to the application owner’s Stripe account when the invoice is paid.
attempt_count
Integer
Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. The value should be an positive integer or zero.
attempted
Boolean
Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
auto_advance
Boolean
Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice’s state will not automatically advance without an explicit action.
billing_reason
String
Indicates the reason why the invoice was created. subscription_cycle indicates an invoice created by a subscription advancing into a new period. subscription_create indicates an invoice created due to creating a subscription. subscription_update indicates an invoice created due to updating a subscription. subscription is set for all old invoices to indicate either a change to a subscription or a period advancement. manual is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The upcoming value is reserved for simulated invoices per the upcoming invoice endpoint. subscription_threshold indicates an invoice created due to a billing threshold being reached.
charge
String
ID of the latest charge generated for this invoice, if any.
created
Integer
IntegerTime at which the object was created. Measured in seconds since the Unix epoch. (Unix epoch)
currency
String
Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer
String
The ID of the customer who will be billed.
description
String
An arbitrary string attached to the object. Often useful for displaying to users. Referenced as ‘memo’ in the Dashboard.
discount
Hash
Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.
discounts
Array
The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
due_date
Integer
The date on which payment for this invoice is due. (Unix epoch) This value will be null for invoices where collection_method=charge_automatically.
ending_balance
Integer
Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
hosted_invoice_url
String
The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
invoice_pdf
String
The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
lines
List
The individual line items that make up the invoice. lines is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any.
livemode
Boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata
Hash
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
next_payment_amount
Integer
The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice. (Unix epoch)
number
String
A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer’s unique invoice_prefix if it is specified.
object
String
String representing the object’s type. Objects of the same type share the same value. The value here is "invoice".
paid
Boolean
The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account.
period_end
Integer
End of the usage period during which invoice items were added to this invoice. (Unix epoch)
period_start
Integer
Start of the usage period during which invoice items were added to this invoice. (Unix epoch)
receipt_number
String
This is the transaction number that appears on email receipts sent for this invoice.
starting_balance
Integer
Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance.
statement_descriptor
String
Extra information about an invoice for the customer’s credit card statement.
status
String
The status of the invoice, one of draft, open, paid, uncollectible, or void.
subscription
String
The subscription that this invoice was prepared for, if any.
subtotal
Integer
Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
tax
Integer
The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
total
Integer
Total after discounts and taxes.
webhooks_delivered
Integer
Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. (Unix epoch)

Invoice Line Items

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
Column Name
Type
Description
1
id
String
Unique identifier for invoice line items.
1
amount
Integer
Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
1
currency
String
Three-letter ISO currency code, in lowercase. Must be a supported currency.
1
customer
String
The ID of the customer who will be billed when this invoice item is billed.
1
date
Integer
Time at which the object was created. Measured in seconds since the Unix epoch.
1
description