View as Markdown
Stripe icon

Stripe ACTION

Update a Payment Intent

Update a payment intent. 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 Payment Intent 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-payment-intent",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    stripe: { authProvisionId: "apn_xxxxxxx" },
    id: "Payment Intent ID",
    amount: 10,
  },
})

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 Payment Intent inputs
Property Type Description
id Payment Intent ID string
Example: pi_0FhyHzGHO3mdGsgAJNHu7VeJ
Required Dynamic
amount Amount integer
Amount. Use the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
Optional
country Country string
Two-letter ISO country code
Optional Dynamic
currency Currency string
Three-letter ISO currency code, in lowercase; must be a supported currency
Optional Dynamic
customer Customer ID string
Example: cus_Jz4ErxGo9t1agg
Optional Dynamic
description Description string
An arbitrary string that you can attach to a the object eg. customer, invoice, etc.
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
paymentMethod Payment Method string
Example: pm_card_visa
Optional Dynamic
receiptEmail Receipt Email string
Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.
Required
setupFutureUsage Setup Future Usage string
Indicate if you intend to use the specified payment method for a future payment. If you intend to only reuse the payment method when your customer is present in your checkout flow, choose on_session; otherwise, choose off_session.
Optional
shippingAddressCity Shipping - Address - City string
City, district, suburb, town, or village.
Optional
shippingAddressCountry Shipping - Address - Country string
Two-letter country code (ISO 3166-1 alpha-2).
Optional
shippingAddressLine1 Shipping - Address - Line 1 string
Address line 1 (e.g., street, PO Box, or company name).
Optional
shippingAddressLine2 Shipping - Address - Line 2 string
Address line 2 (e.g., apartment, suite, unit, or building).
Optional
shippingAddressPostalCode Shipping - Address - Postal Code string
ZIP or postal code.
Optional
shippingAddressState Shipping - Address - State string
State, county, province, or region.
Optional
shippingName Shipping - Name string
Recipient name.
Optional
shippingCarrier Shipping - Carrier string
The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
Optional
shippingPhone Shipping - Phone string
Recipient phone (including extension).
Optional
shippingTrackingNumber Shipping - Tracking Number string
The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
Optional
statementDescriptor Statement Descriptor string
Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.
Optional
statementDescriptorSuffix Statement Descriptor Suffix string
Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement.
Optional
paymentMethodTypes Payment Method Types string[]
Payment method types that may be used
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-payment-intent
Version
0.1.5
App
Stripe
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes