Stripe Integration
Overview
The Stripe integration connects Vantage to the Stripe payment platform, enabling you to manage charges, customers, invoices, balance transactions, payouts, and events directly from your workflows and dashboards.
API Documentation: Stripe API Reference
Prerequisites
| Requirement | Details |
|---|---|
| Stripe Account | A Stripe account with API access enabled |
| API Key | Your Stripe secret key (found in Stripe Dashboard → Developers → API Keys) |
| Auth Type | API Key |
Available Actions
| Action | Description |
|---|---|
| List Charges | Retrieve charges with optional customer, date, and pagination filters |
| Search Charges | Search charges using Stripe's query syntax |
| List Customers | List customers with optional email and pagination filters |
| Search Customers | Search customers by email, name, or metadata |
| List Invoices | Retrieve invoices filtered by customer, status, and date |
| Search Invoices | Search invoices using Stripe's query syntax |
| List Events | Retrieve account events filtered by type and date range |
| Get Balance | Retrieve the current account balance |
| List Balance Transactions | Retrieve balance transaction history |
| List Payouts | Retrieve payout history with pagination |
Configuration
API Key
- Setting:
apiKey - Type: String (required)
- Description: Your Stripe secret API key. This authenticates all requests to the Stripe API. Find it in your Stripe Dashboard under Developers → API Keys.
Tip: Use a restricted key with only the permissions your workflows need, rather than your full secret key.
Use Cases & Examples
Charge Monitoring
Track and manage all charges associated with your customers. Build a workflow that retrieves recent charges, analyzes payment trends, and alerts on failed payments or disputes.
Customer Lifecycle Management
Identify customers with outdated payment information or lapsed subscriptions. Use the search and list capabilities to build automated outreach workflows.
Invoice Processing
Automate invoice tracking by pulling invoices for specific customers, checking payment statuses, and triggering follow-up emails for overdue invoices.
Example: Retrieving Customer Charges
A workflow node configured to list charges for a specific customer:
{
"customerId": "cus_12345",
"limit": 50,
"starting_after": null,
"ending_before": null
}This retrieves up to 50 charges for the specified customer, starting from the most recent. Use the starting_after parameter with the last charge ID to paginate through additional results.
Related Workflow Nodes
- Stripe Charge — Create and manage charges
- Stripe Checkout — Create checkout sessions
- Stripe Customer — Create and manage customers
- Stripe Refund — Process refunds
- Stripe Get Balance — Retrieve account balance
- Stripe List Charges — List and filter charges
- Stripe List Customers — List and filter customers
- Stripe List Events — List account events
- Stripe List Invoices — List invoices
- Stripe List Payouts — List payouts
- Stripe Search Charges — Search charges
- Stripe Search Customers — Search customers
- Stripe Search Invoices — Search invoices
See Also
- Setup Guide — How to connect integrations
- Commerce & Finance Integrations — Overview of all commerce integrations
- Available Integrations — Full integration list