`stripe_list_customers`

Pack: stripe_connect · Endpoint: https://gateway.pipeworx.io/stripe_connect/mcp

List Stripe customers. Supports pagination.

Parameters

Name	Type	Required	Description
`_apiKey`	string	yes	Stripe secret or restricted API key (sk_…)
`limit`	number	no	Max results (1-100, default 10)
`starting_after`	string	no	Cursor for pagination (customer ID)

Example call

Arguments

{
  "_apiKey": "your-stripe_connect-api-key",
  "limit": 20
}

curl

curl -X POST https://gateway.pipeworx.io/stripe_connect/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"stripe_list_customers","arguments":{"_apiKey":"your-stripe_connect-api-key","limit":20}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('stripe_list_customers', {
  "_apiKey": "your-stripe_connect-api-key",
  "limit": 20
});

More examples

{
  "_apiKey": "your-stripe_connect-api-key",
  "limit": 10,
  "starting_after": "cus_ABC123"
}

Response shape

Field	Type	Description
`object`	string	Object type (list)
`data`	array	Array of customer objects
`has_more`	boolean	Whether more results exist
`url`	string	API endpoint URL

Full JSON Schema

{
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Object type (list)"
    },
    "data": {
      "type": "array",
      "description": "Array of customer objects",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Customer ID"
          },
          "object": {
            "type": "string",
            "description": "Object type (customer)"
          },
          "address": {
            "type": [
              "object",
              "null"
            ],
            "description": "Customer address"
          },
          "balance": {
            "type": "integer",
            "description": "Account balance in cents"
          },
          "created": {
            "type": "integer",
            "description": "Creation timestamp"
          },
          "currency": {
            "type": [
              "string",
              "null"
            ],
            "description": "Customer currency"
          },
          "default_source": {
            "type": [
              "string",
              "null"
            ],
            "description": "Default payment source ID"
          },
          "delinquent": {
            "type": "boolean",
            "description": "Account delinquent status"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "Customer description"
          },
          "discount": {
            "type": [
              "object",
              "null"
            ],
            "description": "Applied discount"
          },
          "email": {
            "type": [
              "string",
              "null"
            ],
            "description": "Customer email"
          },
          "invoice_prefix": {
            "type": "string",
            "description": "Invoice prefix"
          },
          "invoice_settings": {
            "type": "object",
            "description": "Invoice settings"
          },
          "livemode": {
            "type": "boolean",
            "description": "Live mode indicator"
          },
          "metadata": {
            "type": "object",
            "description": "Custom metadata"
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "description": "Customer name"
          },
          "phone": {
            "type": [
              "string",
              "null"
            ],
            "description": "Customer phone"
          },
          "preferred_locales": {
            "type": "array",
            "description": "Preferred locales"
          },
          "shipping": {
            "type": [
              "object",
              "null"
            ],
            "description": "Shipping address"
          },
          "tax_exempt": {
            "type": "string",
            "description": "Tax exempt status"
          },
          "test_clock": {
            "type": [
              "string",
              "null"
            ],
            "description": "Test clock ID"
          }
        }
      }
    },
    "has_more": {
      "type": "boolean",
      "description": "Whether more results exist"
    },
    "url": {
      "type": "string",
      "description": "API endpoint URL"
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "stripe_connect": {
      "url": "https://gateway.pipeworx.io/stripe_connect/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

stripe_list_customers