List Stripe customers with optional filters and pagination.

This task lists Stripe customers using the Stripe Java SDK. Supports optional limit and filters.

yaml
type: "io.kestra.plugin.stripe.customer.list"

Examples

List the first 10 customers

yaml
id: list_customers
namespace: company.team

tasks:
  - id: list_customers
    type: io.kestra.plugin.stripe.customer.List
    apiKey: "{{ secret('STRIPE_API_KEY') }}"
    limit: 10

Properties

apiKey *string

Stripe API Key

Secret key for authenticating with Stripe. Starts with 'sk_' for live/test keys.

email string

Optional filter for email

limit integerstring

Default 10

Maximum number of customers to return

Defaults to 10

Outputs

customers array

SubType object

List of customer objects

totalCount integer

Number of customers returned