View as Markdown
ProfitWell icon

ProfitWell ACTION

Update Subscription

Upgrade/downgrade a subscription See docs here
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ProfitWell account once, then configure and run Update 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: "profitwell-update-subscription",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    profitwell: { authProvisionId: "apn_xxxxxxx" },
    subscriptionIdOrAlias: "Subscription ID or Alias",
    effectiveDate: "Effective Date",
  },
})

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 Subscription inputs
Property Type Description
subscriptionIdOrAlias Subscription ID or Alias string
Either the subscription_id or subscription_alias of the subscription
Required
effectiveDate Effective Date string
UNIX timestamp (in seconds) of when this update takes effect.
You can also provide a valid date/time string and Pipedream will automatically convert it to a UNIX timestamp.
Examples: 1644933600 2022-02-15 2022-02-15T14:00Z
Required
planId Plan ID string
The ID of the plan that the user is on. For the sake of consistency (and the ability to later segment your data), this name should be consistent across everyone who is on this plan.
Required
planInterval Plan Interval string
The billing cycle for this plan.
Required
value Value integer
The amount that you bill your user, per billing period, in cents.
Required

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
profitwell-update-subscription
Version
0.0.2
App
ProfitWell
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes