Stripe

---

Configuring Stripe as a Source

Perform the following steps to configure Stripe as a Source in Hevo:

1. Click PIPELINES in the Asset Palette.

2. Click + CREATE in the Pipeline List View page.

3. In the Select Source Type page, select Stripe.

4. In the Configure Your Stripe Source page, specify the following:

   

   • Pipeline Name: A unique Name for your Pipeline.

   • API Key: The API key that you created in Stripe to enable Hevo to read your Stripe data.

5. Click TEST & CONTINUE.

6. Proceed to configuring the data ingestion and setting up the Destination.

---

Source Considerations

• Stripe informs the user of a change in an object in their account through an event. For example, when a charge succeeds, it creates a charge.succeeded event. Stripe maintains a record of all the events that it created for the past 30 days in an events object. Hevo refers to this events object while replicating the data to the Destination to make sure all the deletes and updates are duly accounted for.

  

  Make sure to select Stripe’s events object while creating your Pipeline, else, Hevo will not be able to capture any updates. To enable Hevo to capture deletes for your Pipeline, you need to contact Hevo Support.

• Pausing a Pipeline for more than 30 days can lead to a loss of data, as the events object tracks updates and deletes of the past 30 days only.

---

Data Replication

Default Pipeline Frequency	Minimum Pipeline Frequency	Maximum Pipeline Frequency	Custom Frequency Range (Hrs)
30 Mins	15 Mins	24 Hrs	1-24

Note: The custom frequency must be set in hours, as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

• Historical Data: Hevo ingests your historical data in reverse order, starting from the latest to the earliest Event for all Pipelines. This enables you to have quicker access to your most recent data.

  • For Pipelines created before Release 1.80: Hevo ingests historical data on the basis of the offset selected at the time of creating the Pipeline. By default, it fetches the entire past data associated with your Stripe account.
  • For Pipelines created after Release 1.80: You can select the Historical Sync Duration as per your requirement while creating a Pipeline. Default value: 3 Months.

  Note: The time taken to fetch the historical data depends on the number of days selected at the time of creating the Pipeline. Hevo defaults this period to 30 days. If required, you may customize it to any number or even select the starting date of your Stripe account.

• Incremental Data: Once the historical load is completed, each run of the Pipeline fetches the next available new and modified data. Hevo also fetches the Events object from Stripe, which tracks the updates and deletes made in the last 30 days, in order to sync the related Events with your Destination.

Updated and Deleted Objects

Hevo replicates the updated and deleted records using the Stripe events object. For the deleted records, Hevo sets the is_row_deleted column to True and the deleted_timestamp column to the timestamp when the record was deleted in Stripe, in the ingested data and the Destination.

Hevo identifies the updated and the deleted records from the Stripe events object and replicates that information for the following objects:

Object Name	Event Type Tracked
ACCOUNT	updated
BANK_ACCOUNT	deleted
CARD	deleted
CHARGE	updated
CUSTOMER	- updated - deleted
DISPUTE	updated
INVOICE	- updated - deleted
INVOICE_ITEM	deleted
ORDER	updated
PAYMENT_INTENT	updated
PAYOUT	updated
PERSON	deleted
PRICE	deleted
PRODUCT	- updated - deleted
REFUND	updated
SETUP_INTENT	updated
SUBSCRIPTION	updated

Note: As Hevo also replicates the deleted data now, you might see more Events in your Destination than in the Source.

---

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination:

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Table	Description
Account	Contains all the properties of a Stripe account, such as its current email address and whether the account is enabled to make live charges.
Application Fee	Contains the transaction fee amount collected on top of a charge made for a user.
Application Fee Refund	Contains the reference to the application fee collected from the user and the portion of it to be refunded in case of a transfer reversal.
Authorization	Contains the information that must be approved for any purchase to be completed successfully from an issued card.
Balance transaction	Contains the details of funds moving through an account. It is created for every in-flow and out-flow of funds to and from your Stripe account. Read Balance transaction types.
Bank Account	Contains information of the bank accounts connected to the payment methods of the customers object.
Card	Contains details such as cardholder, and the month and year of expiry of the physical or virtual cards that are issued to the cardholders.
Cardholder	Contains information such as the name, email, and phone number of the individual or business entity who issues a card.
Charge	Contains the details of a charge made on a credit or a debit card. You can retrieve and refund individual charges as well as list all charges. They are identified by a unique, random ID.
Credit Note	Contains the adjusted or refunded amount to be added to an already finalized invoice instead of recreating the invoice.
Credit Note line item	Contains the individual adjustments or refunds that you are adding to a credit note associated with an invoice.
Customer	Contains the details of a customer, such as the name, email, default payment method and delinquency status.
Customer Balance Transaction	Contains the amount by which a customer’s account balance needs to be incremented or decremented.
Coupon	Contains the information about a percent-off or amount-off discount you might want to apply to a customer. It can be applied to invoices or orders.
Discount	Contains the information such as the beginning and ending of the discount and the coupon object. It represents the actual application of a coupon to a particular customer.
Dispute Balance Transaction	Contains the mapping between each dispute and transaction entities. It is a custom table generated by Hevo to maintain data sanity.
Fee Detail	Contains the detailed breakdown of fees paid for each transaction present in the balance transaction table.
File Link	Contains a URL that you can use to retrieve the contents of a file without any authentication.
Invoice	Contains the statements of amounts owed by a customer. Invoices are either generated one-off or periodically from a subscription.
Invoice Line Item	Contains the details of an invoice, such as amount, currency, period and proration. It is stored inside the invoice object.
Payment Intent	Contains the guide for the process of collecting a payment from your customer during a particular session. Read How intents work to know more about the payment flow followed at Stripe.
Payment Method	Contains the details of the payment method that a customer has used on one or more payment intent(s) along with details. Supported Payment Methods are Card (card/wallet), FPX, and ideal.
Payment Method Details	Contains the detailed data for each payment method that is created on your Stripe Account, will be individually stored in your destination to maintain data sanity. Examples: - payment_method_card - payment_method_fpx - payment_method_ideal
Payout	Contains the details of the received funds from Stripe. It is created when you initiate a payout to either a bank account or debit card of a connected Stripe account.
Person	Contains the details of the person linked to a Stripe account.
Plan (pricing)	Contains the details such as the base price, currency and billing cycle for recurring purchases of products. It helps you track the pricing.
Price	Contains the details such as the unit cost, currency, and billing cycle for recurring and one-time purchases of the different products you offer to your customers. For example, a standard or premium version of your service.
Product	Contains a list of all offers for the product. Each product can have multiple tiers of pricing plans.
Promotion Code	Contains a customer-redeemable code that can be used to create single or multiple codes for a coupon.
Refund	Contains the details of a charge that is to be refunded due to a dispute, return, or failure to deliver a service.
Review	Contains human-added information to supplement automated fraud detection cases.
Setup Intent	Contains the guide for the process of saving a customer’s payment credentials for future payments.
Source	Contains the details of a customer’s payment methods that can be used with the Stripe API.
Subscription	Contains the details of a recurring charge for a customer. Each subscription has multiple line items.
Subscription Item	Contains line item data for each subscription. Each line item is associated with a plan.
Subscription Schedule	Contains the attributes required to manage the lifecycle of customers’ subscriptions by predefining existing changes.
Top-Up	Contains the amount by which customers wish to top up their Stripe account balance.
Transaction	Contains details of funds entering or leaving a Stripe account. A transaction object is created whenever an issued card is used for making a purchase or a refund.
Transfer	Contains the details to move funds between Stripe accounts such as amount, destination and so on. It is used when you need to directly move a fund from your customer to the seller who’s offering the service through your platform.
Transfer Reversal	Contains the amount that is to be deducted from the seller’s account (who originally received it via a successful transfer) and added back to your platform.
Usage Record	Contains a report of a customer’s usage and other metrics that are sent to Stripe.

---

Limitations

• For new and existing Pipelines, Hevo replicates only the data that has been deleted after Release 1.86.

---

See Also

• Events in Stripe
• Handling of Deletes
• Hevo-generated Metadata