Create Plan
profitwell.create_plan
ActionBusiness appsconnection required
Calls the ProfitWell API with the connection's credentials.
Define a new manually-added plan that subscriptions can point at.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- ProfitWell
- Secret shape
- the private API token, or {"api_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
plan_id The id for the new plan. It must not collide with another manual plan or with one coming from a connected billing provider. | string | Yes | — | — | foo_plan |
name The plan's display name in ProfitWell. | string | Yes | — | — | Foo Plan |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"name": "Foo Plan",
"plan_id": "foo_plan"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The new plan's id. | string | — |
name The new plan's display name. | string | — |
{
"id": "",
"name": ""
}Notes
- ProfitWell also creates a plan implicitly the first time a manually-added subscription names one, so this node is for defining a plan ahead of any subscriber.
See Create Plan run in a workflow.
In a technical demo we add the ProfitWell connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.