Book a demo

List Customers

stripe.list_customers
ActionBusiness appsconnection required

Calls the Stripe API with the connection's secret key.

List Stripe customers, newest first, optionally filtered by email.

Ask about StripeAll Stripe nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Stripe
Secret shape
the Stripe secret key (sk_...)
Resolved by
config.connection_id, else node.connection_id

Configuration

6 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
email
Return only customers with this exact email address.
stringNo—email format—
limit
How many objects to return, 1-100. Stripe defaults to 10.
numberNo101–100—
starting_after
Cursor: return the page after this object id, for walking forward.
stringNo———
ending_before
Cursor: return the page before this object id, for walking backward.
stringNo———
created_after
Only objects created at or after this Unix timestamp, in seconds.
numberNo—≥ 0—
created_before
Only objects created at or before this Unix timestamp, in seconds.
numberNo—≥ 0—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "limit": 10
}

Output

One shape.

result

FieldTypeExample
customers[].id
The customer id (cus_...).
string—
customers[].email
The customer's email address, or null.
string—
customers[].name
The customer's full name, or null.
string—
customers[].description
The note stored on the customer.
string—
customers[].phone
The customer's phone number, or null.
string—
customers[].currency
The currency the customer is billed in.
string—
customers[].delinquent
True when an invoice is unpaid.
boolean—
customers[].created
Creation time, Unix seconds.
number—
customers[].metadata
Key/value pairs on the customer.
object—
count
How many objects this page returned.
number—
has_more
True when Stripe has a further page to fetch.
boolean—
{
  "count": 0,
  "customers": [
    {
      "created": 0,
      "currency": "",
      "delinquent": false,
      "description": "",
      "email": "",
      "id": "",
      "metadata": {},
      "name": "",
      "phone": ""
    }
  ],
  "has_more": false
}

Related Stripe nodes

Templates that use Stripe

Solutions with Stripe

See List Customers run in a workflow.

In a technical demo we add the Stripe connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales