Appearance
subscription.usage.summary ​
Report organization usage for a period and its cost, priced from the local catalog.
Report what an organization used this period and what it costs.
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. |
period_start | string | No | — | Inclusive period start ISO timestamp. Defaults to the current billing period. |
period_end | string | No | — | Exclusive period end ISO timestamp. |
include_daily | boolean | No | — | Include the per-day usage series for charting. Defaults to true. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | — |
subscription_uuid | uuid | No | — | — |
currency | string | No | — | — |
period | json | No | — | — |
recurring | json | No | — | — |
usage | json | No | — | — |
totals | json | No | — | — |
daily | list | No | — | — |
unpriced | list | No | — | — |
freshness | json | No | — | — |
notices | list | No | — | — |
actions | json | No | — | — |
status | string | 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 | — | summarize | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | summarize | completed | — |
* (any state) | fail | failed | — |
Business Errors ​
| Code | Message Template |
|---|---|
USAGE_SUMMARY_ORGANIZATION_NOT_FOUND | Organization {organization_uuid} not found |
USAGE_SUMMARY_PERIOD_INVALID | |
BILLING_AUTHORIZATION_REQUIRED |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "subscription.usage.summary",
"initial_data": {
"organization_uuid": "value"
}
}