Appearance
lumen.org.set-plan ​
Upsert the Lumen plan row for an organization (plan tier, rate limit, retention)
Upsert the Lumen plan row for an organization.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-lumen |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | string | Yes | — | Public UUID of the org being provisioned. |
plan | string | No | — | Plan tier: free |
rate_limit_per_minute | integer | No | — | Per-minute ingest cap. 0 = use the tier default. |
retention_days | integer | No | — | Retention override in days. 0 = use the tier default. |
enabled | boolean | No | — | Whether Lumen ingest is active for this org. |
included_entries_month | integer | No | — | Tier-included ingested entries per month. 0 = tier default. |
max_entries_month | integer | No | — | Hard monthly entry cap (included + purchased packs). 0 = tier default. |
included_storage_gb | integer | No | — | Tier-included retained storage in GB. 0 = tier default. |
max_storage_bytes | integer | No | — | Retained-storage cap in bytes (included + purchased GB). 0 = tier default. |
workflow_run_id | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | string | No | — | — |
plan | string | No | — | — |
rate_limit_per_minute | integer | No | — | — |
retention_days | integer | No | — | — |
enabled | boolean | No | — | — |
included_entries_month | integer | No | — | — |
max_entries_month | integer | No | — | — |
included_storage_gb | integer | No | — | — |
max_storage_bytes | integer | No | — | — |
provisioned | boolean | No | — | — |
reason | string | No | — | — |
http_status | integer | No | — | — |
detail | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
workflow_run_id | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "lumen.org.set-plan",
"initial_data": {
"organization_uuid": "value"
}
}