Appearance
subscription.usage.consolidate ​
Snapshot retained workflow and audit storage usage for one organization
Consolidate retained workflow/audit storage for billing and retention reporting.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-subscription |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Organization UUID |
subscription_uuid | uuid | No | — | Subscription UUID for billing attribution |
interval | string | No | — | Consolidation interval label: hour or day |
period_start | string | No | — | Inclusive period start ISO timestamp |
period_end | string | No | — | Exclusive period end ISO timestamp |
window_hours | integer | No | — | Window length when period_start is omitted |
persist | boolean | No | — | Persist or update the usage snapshot |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | — |
subscription_uuid | uuid | No | — | — |
snapshot | json | No | — | — |
usage_measurement_uuid | uuid | No | — | — |
lumen_usage | json | No | — | — |
usage_measurement_uuids | json | No | — | — |
workflow_executions | integer | No | — | Workflow runs that reached a terminal state in the period. |
workflow_billable_units | float | No | — | Charged units the billable_event ledger recorded for the period; null when the ledger table is unavailable. |
lumen_measurement_uuids | json | No | — | — |
policy | json | No | — | — |
persisted | boolean | No | — | — |
warnings | list | No | — | — |
completed_at | string | No | — | — |
failed_at | 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 | — | — |
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 | — |
pending | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "subscription.usage.consolidate",
"initial_data": {
"organization_uuid": "value"
}
}