Stripe data source
Learn how to set up a Stripe data source and move your data into one of the data destinations supported by Coupler.io.
Two steps to complete the setup
1. Set up your data source
1.1. Select an application: Stripe
1.2. Connect your Stripe account
Note: The user has to be an Administrator or Developer of the Stripe account in order to use this integration.
- Click "Connect".
- Enter your Stripe email address and click "Continue".
- Enter your password and click "Log in".
- Select one of the accounts and click "Connect".
1.3. Select the data entity
Select one of the available data entities. Right now Coupler.io allows fetching the next data: Application fees, Accounts, Balance transactions, Charges, Coupons, Customers, Disputes, Events, File links, Files, Invoice items, Invoices, Payment intents, Payouts, Plans, Prices, Products, Promotion codes, Quotes, Refunds, Setup intents, Shipping rates, Subscription schedules, Subscriptions, Subscriptions with line items, Tax rates, Topups, Transactions, Transfers, Value lists.
1.4. Set up advanced settings (optional)
There are 2 filters available for almost data entities (except the "Quotes" data entity) that you can use to narrow results:
1.4.1. Created after date - specify this date to export data added after it (e.g. after 2020-01-01 09:00). This field supports macros.
1.4.2. Created before date - specify this date to export data added before it (e.g. before 2021-01-01 09:00). This field supports macros.
Also in the advanced settings, you can see additional filter specific for selected data entity - e.g. for the "Balance transactions" entity you also can specify "Balance transaction type":
1.5. Set up advanced filters (optional)
Coupler.io also allows you to filter data by any available advanced filter supported by Stripe API. Let's review this process using an example - e.g. fetch only invoices that are collected automatically:
- Data entity: Invoices
- Filter: collection_method
- Value: charge_automatically
All filters that can be used for data entities:
Entity | Additional filters | Filter description |
Application fees | - | - |
Balance transactions | currency | Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency. |
|
source | Only returns the original transaction. |
Charges |
customer | Only return charges for the customer specified by this customer ID. |
payment_intent | Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. | |
Connected accounts | - | - |
Coupons | - | - |
Customers | A case-sensitive filter on the list based on the customer’s email field. The value must be a string. | |
test_clock |
Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set. |
|
Disputes | status | Select Issuing disputes with the given status. Possible enum values: won, lost, submitted, unsubmitted, expired. |
Events | delivery_success | Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned. |
types | An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either type or types, but not both. |
|
File links | expired | Filter links by their expiration status. By default, all links are returned. |
file | Only return links for the given file. | |
Files | purpose | The file purpose to filter queries by. If none is provided, files will not be filtered by purpose. |
Invoice items | customer | The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. |
invoice |
Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed. |
|
pending | Set to true to only show pending invoice items, which are not yet attached to any invoices. Set to false to only show invoice items already attached to invoices. If unspecified, no filter is applied. | |
Invoices | customer | Only return invoices for the customer specified by this customer ID. |
status | The status of the invoice, one of draft, open, paid, uncollectible, or void. | |
subscription | Only return invoices for the subscription specified by this subscription ID. | |
due_date | A filter on the list based on the object due_date field. The value can be a string with an integer Unix timestamp. | |
collection_method | The collection method of the invoice to retrieve. Either charge_automatically or send_invoice. | |
Payment intents | customer | Only return PaymentIntents for the customer specified by this customer ID. |
Payouts | status | Only return payouts that have the given status: pending, paid, failed, or canceled. |
arrival_date | A filter on the list based on the object arrival_date field. The value can be a string with an integer Unix timestamp. | |
Plans | active | Only return plans that are active or inactive (e.g., pass false to list all inactive plans). |
product | Only return plans for the given product. | |
Prices | active | Only return prices that are active or inactive (e.g., pass false to list all inactive prices). |
currency | Only return prices for the given currency. | |
product | Only return prices for the given product. | |
types | Only return prices of type recurring or one_time. | |
lookup_keys | Only return the price with these lookup_keys, if any exist. | |
recurring | Only return prices with these recurring fields. | |
Products | active | Only return products that are active or inactive (e.g., pass false to list all inactive products). |
ids | Only return products with the given IDs. | |
shippable | Only return products that can be shipped (i.e., physical, not digital products). | |
url | Only return products with the given url. | |
Promotion codes | active | Filter promotion codes by whether they are active. |
code | Only return promotion codes that have this case-insensitive code. | |
coupon | Only return promotion codes for this coupon. | |
customer | Only return promotion codes that are restricted to this customer. | |
Quotes | customer | The ID of the customer whose quotes will be retrieved. |
status | The status of the quote. Can be one of: draft, open, accepted, canceled. | |
test_clock | Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set. | |
Refunds | charge | Only return refunds for the charge specified by this charge ID. |
payment_intent | Only return refunds for the PaymentIntent specified by this ID. | |
Setup intents | customer | Only return SetupIntents for the customer specified by this customer ID. |
payment_method | Only return SetupIntents associated with the specified payment method. | |
attach_to_self | If present, the SetupIntent’s payment method will be attached to the in-context Stripe Account. It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer. |
|
Shipping rates | active | Only return shipping rates that are active or inactive. |
currency | Only return shipping rates for the given currency. | |
Subscription schedules | customer | Only return subscription schedules for the given customer. |
canceled_at | A filter on the list based on the object canceled_at field. The value can be a string with an integer Unix timestamp. | |
completed_at |
A filter on the list based on the object completed_at field. The value can be a string with an integer Unix timestamp. |
|
released_at | A filter on the list based on the object released_at field. The value can be a string with an integer Unix timestamp. |
|
scheduled |
Only return subscription schedules that have not started yet. | |
Subscriptions | customer | The ID of the customer whose subscriptions will be retrieved. |
price | Filter for subscriptions that contain this recurring price ID. | |
collection_method | The collection method of the subscriptions to retrieve. Either charge_automatically or send_invoice. | |
current_period_end |
A filter on the list based on the object current_period_end field. The value can be a string with an integer Unix timestamp. |
|
current_period_start | A filter on the list based on the object current_period_start field. The value can be a string with an integer Unix timestamp. |
|
test_clock | Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set. | |
Subscriptions with line items | customer | The ID of the customer whose subscriptions will be retrieved. |
price | Filter for subscriptions that contain this recurring price ID. | |
collection_method | The collection method of the subscriptions to retrieve. Either charge_automatically or send_invoice. | |
current_period_end |
A filter on the list based on the object current_period_end field. The value can be a string with an integer Unix timestamp. |
|
current_period_start | A filter on the list based on the object current_period_start field. The value can be a string with an integer Unix timestamp. | |
test_clock |
Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set. | |
Tax rates | active | Optional flag to filter by tax rates that are either active or inactive (archived). |
inclusive | Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). | |
Topups | status | Only return top-ups that have the given status. One of canceled, failed, pending or succeeded. |
amount |
A filter on the list based on the object amount field. The value can be a string with an integer amount. | |
Transfers | destination | Only return transfers for the destination specified by this account ID. |
transfer_group | Only return transfers with the specified transfer group. | |
Value lists | alias | The alias used to reference the value list when writing rules. |
contains | A value contained within a value list - returns all value lists containing this value. | |
Issuing transactions | card | Only return transactions that belong to the given card. |
cardholder | Only return transactions that belong to the given cardholder. | |
type | Only return transactions that have the given type. One of capture or refund. |
You can double-check available filters directly in the Stripe API: https://stripe.com/docs/api/.
2. Set up your data destination
Continue setting up the integration depending on the application you want to import the data to. Select your tool from the list of supported data destinations and follow the relevant setup guide.