View as Markdown
Stripe icon

Stripe ACTION

Search Customers

Search customers by various attributes like email domain, created date, etc. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Stripe account once, then configure and run Search Customers from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "stripe-search-customers",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    stripe: { authProvisionId: "apn_xxxxxxx" },
    query: "Search Query",
    email: "Email",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Search Customers inputs
Property Type Description
query Search Query string
Search query using Stripe's search query language. Example: email~"example.com" AND created>1609459200
Optional
email Email string
Search by customer email address (e.g.,user@example.com)
Optional
emailDomain Email Domain string
Search by email domain (e.g., example.com to find all emails from that domain)
Optional
createdAfter Created After string
Filter customers created after this date (format: YYYY-MM-DD)
Optional
createdBefore Created Before string
Filter customers created before this date (format: YYYY-MM-DD)
Optional
limit Result Limit integer
Maximum number of customers to return
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
stripe-search-customers
Version
0.0.5
App
Stripe
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes