Appearance
stripe.customers.search_customers ​
Search Stripe customers by query (email, metadata, name)
Search customers with Stripe's query language, e.g. email:'alice@example.com' metadata['end_user_uuid']:'...'
Search is the right tool for "find the customer for this person"; list is for paging the whole set. Stripe's search index is eventually consistent — a customer created moments ago may not appear yet.
Acts on the CUSTOMER'S OWN Stripe account, authenticated via the org-scoped Stripe connection selected by cloud_connection_uuid.
Inputs:
- cloud_connection_uuid: Org-scoped Stripe connection (customer's own account).
- query: Stripe search query string.
- limit: Page size, 1-100 (default: 20) (optional).
- page: Cursor from a previous search's next_page (optional).
Outputs (terminal state_data):
- customers: list
- total: int
- has_more: bool
- next_page: str
Connection required: cloud_connection_uuid — the organization's own Stripe account credentials; there is no platform-key fallback.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-stripe |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | Yes | — | Org-scoped Stripe connection (customer's own account) |
query | string | Yes | — | Stripe search query string |
limit | integer | No | — | Page size, 1-100 (default: 20) |
page | string | No | — | Cursor from a previous search's next_page |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
customers | list | No | — | — |
total | integer | No | — | — |
has_more | boolean | No | — | — |
next_page | string | No | — | — |
cloud_connection_uuid | uuid | No | — | — |
query | string | No | — | — |
limit | integer | No | — | — |
page | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_layer | integer | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "stripe.customers.search_customers",
"initial_data": {
"cloud_connection_uuid": "value",
"query": "value"
}
}