Update Customer

stripe.update_customer
ActionBusiness appsconnection required

Calls the Stripe API with the connection's secret key.

Update the details stored on an existing Stripe customer.

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Stripe
Secret shape
the Stripe secret key (sk_...)
Resolved by
config.connection_id, else node.connection_id

Configuration

7 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
customer_id
The customer to act on (cus_...). Supports {{ }} expressions.
stringYes——cus_NffrFeUfNV2Hib
email
New email address. Leave blank to keep the current one.
stringNo—email format—
name
New full name. Leave blank to keep the current one.
stringNo———
description
New free-text note shown on the customer in the Stripe dashboard.
stringNo———
phone
New phone number. Leave blank to keep the current one.
stringNo———
metadata
Key/value pairs stored on the customer and returned on every read.
objectNo———
idempotency_key
Overrides the key this node derives from the step. Set it to a business identifier (an order id, say) when the same write must not repeat across runs; leave it blank and a retry of this step reuses the step's own key.
stringNo—≤ 255 characters—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "customer_id": "cus_NffrFeUfNV2Hib"
}

Output

One shape.

result

FieldTypeExample
id
The customer id (cus_...).
string—
email
The customer's email address, or null.
string—
name
The customer's full name, or null.
string—
description
The free-text note stored on the customer.
string—
phone
The customer's phone number, or null.
string—
currency
The three-letter currency the customer is billed in.
string—
delinquent
True when the latest invoice has not been paid.
boolean—
created
Creation time, as a Unix timestamp in seconds.
number—
metadata
The key/value pairs stored on the customer.
object—
{
  "created": 0,
  "currency": "",
  "delinquent": false,
  "description": "",
  "email": "",
  "id": "",
  "metadata": {},
  "name": "",
  "phone": ""
}

Notes

  • Only the fields you fill in are sent; a blank field is left unchanged.

See Update Customer run in a workflow.

In a technical demo we add the Stripe connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.