stripe.customers.list_customers ​
List Stripe customers with optional filters
List Stripe customers with optional email and pagination filters.
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 UUID (required).
- email: Filter by exact customer email (optional).
- limit: Max customers per page, 1–100 (optional, default: 10).
- starting_after: Pagination cursor — customer ID to start after (optional).
Outputs (terminal state_data):
- customers: list of
- total: int — number of customers returned in this page
- has_more: bool — whether additional pages exist
- next_cursor: str — customer ID to pass as starting_after for the next page (empty when exhausted)
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) |
email | string | No | — | Filter by exact customer email |
limit | integer | No | — | Max customers per page 1–100 (default: 10) |
starting_after | string | No | — | Pagination cursor — customer ID to start after |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | No | — | — |
email | string | No | — | — |
limit | integer | No | — | — |
starting_after | string | No | — | — |
customers | list | No | — | — |
total | integer | No | — | — |
has_more | boolean | No | — | — |
next_cursor | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | 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.list_customers",
"initial_data": {
"cloud_connection_uuid": "value"
}
}