View as Markdown
Stripe icon

Stripe ACTION

Update Invoice

Update an invoice. 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 Invoice 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-invoice",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    stripe: { authProvisionId: "apn_xxxxxxx" },
    id: "Invoice ID",
    description: "Description",
  },
})

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 Invoice inputs
Property Type Description
id Invoice ID string
Example: in_0JMBoWGHO3mdGsgA6zwttRva
Required Dynamic
description Description string
An arbitrary string that you can attach to a the object eg. customer, invoice, etc.
Optional
autoAdvance Auto Advance boolean
Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
Optional
collectionMethod Collection Method string
Either charge_automatically or send_invoice. This field can be updated only on draft invoices.
Optional
daysUntilDue Days Until Due integer
The number of days from which the invoice is created until it is due. Only valid for invoices where collection_method=send_invoice. This field can only be updated on draft invoices.
Optional
paymentMethodType Payment Method Type string
The type of payment method to create
Optional
defaultPaymentMethod Default Payment Method string
Must belong to the customer associated with the invoice. If not set, defaults to the subscription’s default payment method, if any, or to the default payment method in the customer’s invoice settings.
Optional Dynamic
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-invoice
Version
0.1.5
App
Stripe
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes