Search customers with the Stripe API

Searches the customers with the Stripe search query language, by email, name, phone, creation date or metadata. The response has data, has_more and next_page; send next_page as page to get the next page. A customer created or updated in the last minute may not show up yet.

Identifier
stripe_search_customers

The request

POST https://connect.reportei.com/api/tools/stripe_search_customers/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "query": "<query>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
querystringYesUp to 10 clauses joined by AND or by OR, never both, for example email:"ana@example.com" or name~"silva". Fields: email, name and phone (a colon matches exactly, a tilde matches part of the text, with at least 3 characters), metadata["key"]:"value", and created (Unix seconds), which also takes a greater-than or less-than sign, optionally followed by an equals sign, in place of the colon. Text values go in double quotes, and a leading - negates a clause.
limitintegerNoCustomers per page, from 1 to 100. The default is 10.
pagestringNoThe next_page value of the previous response, to get the next page.

Supported connections

Your customer connects their Stripe account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/stripe_search_customers. It becomes your agent's tool definition with no conversion.

Other Stripe tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.