Stripe Collectors
Overview
DataBlend collects the following Stripe data types:
- Charges
- Credit Notes
- Customer By ID
- Disputes
- Invoice By ID
- Invoice Items By ID
- Invoice Line Items
- Invoice Payments
- Payout By ID
- List Invoices
- List InvoiceItems
- List Payouts
- List Customers
- List Balance Transactions
- List Checkouts
- List Events
- List Coupons
- List Promo Codes
- List Checkout Sessions
- List Prices
- List Payment Links
- Payment Intents
- Payment Intent Line Items
- Products
- Refunds
- Reports
- Search Payment Intents
- Subscriptions
- Subscription Items
|
Field |
Required/ Optional |
Comments |
|---|---|---|
|
Type |
Required |
Stripe |
|
Name |
Required |
Descriptive free-text name for the collector |
|
Data Source |
Required |
Select a pre-configured data source from the drop down or click Create New to create a new data source. |
|
Schema Name |
Required |
Enter a name for the schema where the collected data will be stored. This can be a pre-configured schema or a new schema which will be created the first time the collector is run. |
|
Credential |
Required |
Select a pre-configured credential from the drop-down. |
|
Stripe Collector Type |
Required |
Select from preconfigured drop-down menu. |
|
Use Latest API |
Optional, leave off for normal use. Only turn on if newer/raw API field missing from the standard (SDK) output is necessary. Be aware that the column/field shape can differ between two modes, so re-check the schema. |
When toggled off, the collector uses the Stripe.net SDK. Objects come back as typed SDK models pinned to the API version bundled with DataBlend's SDK. When toggled on, the collector bypasses the SDK and calls Stripe's REST API directly over HTTP, returning the raw JSON from the newer API version. |
- Format: a comma-separated list of expandable field paths (the code does Expand.Split(',')). No brackets, no quotes, just field1,field2.
- List collectors (e.g. List Invoices, List Customers) require the data.prefix to expand a field on each item in the list. Examples:
- List Invoices → data.customer,data.charge
- List Subscriptions → data.default_payment_method
- Single-object collectors (e.g. Get Invoice) drop the prefix → customer,charge.
-
Optional: leave the field blank if nested objects don't need to be expanded. Valid values are whatever Stripe documents as expandable for that specific object. Check the "Expandable" markers in the Stripe API reference for the endpoint in question. Stripe rejects non-expandable paths with an error.