Update an existing customer in Stripe.

This task modifies a customer in Stripe with optional fields like name, email, and metadata.

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

Examples

Update a customer's name and metadata

yaml
id: update_customer
namespace: company.team

tasks:
  - id: update_customer
    type: io.kestra.plugin.stripe.customer.Update
    apiKey: "{{ secret('STRIPE_API_KEY') }}"
    customerId: "cus_123456789"
    name: "John Updated"
    metadata:
      plan: "enterprise"
      updated_by: "admin"

Properties

apiKey *string

Stripe API Key

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

customerId *string

The customer ID to update

email string

Customer email address

metadata object

Key-value pairs for storing additional information

name string

Customer name

Outputs

customerData object

The full customer object as a map

customerId string

The updated customer ID