View as Markdown
Stripe icon

Stripe ACTION

Create Subscription

Create a subscription. 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 Subscription 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-subscription",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    stripe: { authProvisionId: "apn_xxxxxxx" },
    customer: "Customer ID",
    items: ["Price ID"],
  },
})

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 Subscription inputs
Property Type Description
customer Customer ID string
Example: cus_Jz4ErxGo9t1agg
Required Dynamic
items Price ID string[]
Example: price_0HuVAoGHO3mdGsgAi0l1fEtm
Required Dynamic
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
description Description string
An arbitrary string that you can attach to a the object eg. customer, invoice, etc.
Optional
collectionMethod Collection Method string
Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active. Defaults to charge_automatically.
Optional
daysUntilDue Days Until Due integer
Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where collection_method is set to send_invoice.
Optional
paymentType Payment Method Types string
Payment method types that may be used
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
automaticTaxEnabled Automatic Tax Enabled boolean
Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
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 Automatic Tax - Liability - Type is account.
Optional
paymentBehavior Payment Behavior string
Specifies whether to create the subscription in the incomplete or active state. Only applies to subscriptions when Collection Method is set to charge_automatically. See the documentation.
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-create-subscription
Version
0.1.7
App
Stripe
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes