Create

Create a new customer in Stripe.

This task creates a customer in Stripe with optional name, email, and metadata. ⚠️ By default only the customerId is returned in the output. If includeFullCustomerData is set to true, the full customer object will be included, which may contain personal data (PII).

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

Examples

Create a customer with name, email, and metadata

yaml

id: create_customer
namespace: company.team

tasks:
  - id: create_customer
    type: io.kestra.plugin.stripe.customer.Create
    apiKey: "{{ secret('STRIPE_API_KEY') }}"
    name: "John Doe"
    email: "[email protected]"
    metadata:
      plan: "pro"
      signup_source: "landing_page"

Properties

apiKey *string

Stripe API Key

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

email *string

Customer email address

name *string

Customer name

includeFullCustomerData booleanstring

Default false

Whether to include full customer object in output

⚠️ May contain personal data (PII). Use only if necessary.

metadata object

Key-value pairs for storing additional information

Outputs

customerData object

The full customer object as a map (only if includeFullCustomerData = true)

customerId string

The created customer ID

​Create

Create