View as Markdown
ProfitWell icon

ProfitWell ACTION

Create Subscription

Create a subscription See docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ProfitWell 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: "profitwell-create-subscription",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    profitwell: { authProvisionId: "apn_xxxxxxx" },
    userId: "User ID",
    userAlias: "User Alias",
  },
})

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
userId User ID string
Only use if you are referencing an existing user for whom you need to create an additional subscription.
Optional
userAlias User Alias string
For a new user, you can include your own identifier here. If creating a subscription for an existing user, this can be used instead of User ID.
Optional
subscriptionAlias Subscription Alias string
If included, you can use this to reference the subscription later, instead of its ID.
Note that this alias must be unique across all users in your company, and cannot contain more than 36 characters.
Optional
email Email Address string
The email address of the user. This will be the display text that is used on the Customers tab.
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
planCurrency Plan Currency string
The currency in which users of this plan are charged. See the docs for the full list of accepted currency codes.
Optional
status Status string
Optional
value Value integer
The amount that you bill your user, per billing period, in cents.
Required
effectiveDate Effective Date string
UNIX timestamp (in seconds) of when the subscription starts.
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

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