View as Markdown
Recharge icon

Recharge ACTION

Cancel Subscription

Cancels an existing subscription. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Recharge account once, then configure and run Cancel 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: "recharge-cancel-subscription",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    recharge: { authProvisionId: "apn_xxxxxxx" },
    subscriptionId: "Subscription ID",
    cancellationReason: "Cancellation Reason",
  },
})

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.

Cancel Subscription inputs
Property Type Description
subscriptionId Subscription ID string
Select a subscription or provide a custom subscription ID.
Required Dynamic
cancellationReason Cancellation Reason string
Reason for subscription cancellation.
Required
cancellationReasonComment Cancellation Reason Comment string
Cancellation reason comment. Maximum length is 1024 characters.
Optional
sendEmail Send Email boolean
If set to false, subscription cancelled email will not be sent to customer and store owner.
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
recharge-cancel-subscription
Version
0.0.2
App
Recharge
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes