View as Markdown
Stripe icon

Stripe ACTION

Update a Customer

Update a customer. See the documentation.
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Stripe account once, then configure and run Update a Customer from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "stripe-update-customer",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    stripe: { authProvisionId: "apn_xxxxxxx" },
    customer: "Customer ID",
    name: "Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Update a Customer inputs
Property Type Description
customer Customer ID string
Example: cus_Jz4ErxGo9t1agg
Required Dynamic
name Name string
The customer's full name or business name.
Optional
email Email string
Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.
Optional
phone Phone string
The customer's phone number. This field is required when creating a new customer. If you do not provide a phone number, the customer will be created with the phone number of the connected account.
Optional
description Description string
An arbitrary string that you can attach to a the object eg. customer, invoice, etc.
Optional
addressCity Address - City string
City, district, suburb, town, or village.
Optional
addressCountry Address - Country string
Two-letter country code (ISO 3166-1 alpha-2).
Optional
addressLine1 Address - Line 1 string
Address line 1 (e.g., street, PO Box, or company name).
Optional
addressLine2 Shipping - Address - Line 2 string
Address line 2 (e.g., apartment, suite, unit, or building).
Optional
addressPostalCode Address - Postal Code string
ZIP or postal code.
Optional
addressState Shipping - Address - State string
State, county, province, or region.
Optional
metadata Metadata object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
stripe-update-customer
Version
0.1.5
App
Stripe
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes