List Active Plan IDs
profitwell.list_metric_plan_ids
ActionBusiness appsconnection required
Calls the ProfitWell API with the connection's credentials.
List the plan ids that currently have active customers, by MRR.
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
1 field, none 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 |
|---|---|---|---|---|---|
limit How many plan ids to return. ProfitWell's maximum, and its default, is 150. | number | No | 150 | 1–150 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"limit": 150
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
plan_ids The active plan ids, ordered by MRR descending. | array | — |
count How many plan ids came back. | number | — |
{
"count": 0,
"plan_ids": []
}Notes
- These are the ids to feed a metrics node's 'plan_id'. A plan with no active customers is not listed, even when it exists.
Related ProfitWell nodes
See List Active Plan IDs 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.