View as Markdown
Stripe icon

Stripe ACTION

Create Invoice

Create an invoice. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Stripe account once, then configure and run Create 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-create-invoice",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    stripe: { authProvisionId: "apn_xxxxxxx" },
    autoAdvance: true,
    automaticTaxEnabled: true,
  },
})

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.

Create Invoice inputs
Property Type Description
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
automaticTaxEnabled Automatic Tax Enabled boolean
Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or tax_behavior=unspecified) cannot be added to automatic tax invoices.
Optional
automaticTaxLiabilityType Automatic Tax Liability Type string
Type of the account referenced in the request.
Optional
automaticTaxLiabilityAccount Automatic Tax Liability Account string
The connected account being referenced when type is account.
Optional
collectionMethod Collection Method string
Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to charge_automatically.
Optional
customer Customer ID string
Example: cus_Jz4ErxGo9t1agg
Required 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
subscription Subscription ID string
Example: sub_K0CC9GlXAWpBQg
Optional Dynamic
daysUntilDue Days Until Due integer
The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
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

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-create-invoice
Version
0.1.5
App
Stripe
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes