Appearance
data.subscription.plan.list ​
List the active SubscriptionPlan catalog (UUID-only)
List the active SubscriptionPlan catalog (UUID-only).
Plans are app-global (not org-scoped); this lists every active plan so a caller can pick one. Inputs: organization_uuid (optional, ignored), include_inactive (optional), limit/offset.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-subscription |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | Organization UUID (accepted for context; plans are global) |
include_inactive | boolean | No | — | Include inactive plans (default False) |
limit | integer | No | 50 | Page size — hard-capped by the engine |
offset | integer | No | 0 | Pagination offset |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
items | list | Yes | — | — |
count | integer | Yes | — | — |
total | integer | Yes | — | — |
limit | integer | Yes | — | — |
offset | integer | Yes | — | — |
error | string | No | — | — |
error_type | string | No | — | Error-as-field envelope populated when query() raises. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "data.subscription.plan.list",
"initial_data": {
"organization_uuid": "value",
"include_inactive": true,
"limit": 123,
"offset": 123
}
}