Appearance
subscription.retention.billing.quote ​
Return pending price-model status for retention billing quote.
Fallback quote for retention billing when a price model is unavailable.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-subscription |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
subscription_uuid | uuid | No | — | — |
workflow_state_retention_days | integer | No | — | — |
workflow_event_retention_days | integer | No | — | — |
scheduled_transition_retention_days | integer | No | — | — |
audit_log_retention_days | integer | No | — | — |
usage_snapshot_retention_days | integer | No | — | — |
max_retained_workflow_storage_bytes | integer | No | — | — |
max_retained_audit_storage_bytes | integer | No | — | — |
user_uuid | uuid | No | — | — |
return_channel | json | No | — | — |
agent_session_ref | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | Organization UUID. |
flow | string | No | — | Requested billing flow. |
supported | boolean | No | — | Whether the flow can mutate billing today. |
status | string | No | — | Support status. |
unsupported_reason | string | No | — | Why the flow is not mutating yet. |
requested | json | No | — | Caller request normalized for support handoff. |
required_capabilities | list | No | — | Missing model/platform capabilities. |
next_action | json | No | — | UI or agent follow-up instruction. |
completed_at | string | No | — | Completion timestamp. |
subscription_uuid | uuid | No | — | — |
current_policy | json | No | — | — |
requested_policy | json | No | — | — |
quote | json | No | — | — |
failed_at | string | No | — | Failure timestamp. |
failure_reason | string | No | — | Failure reason. |
failure_type | string | No | — | Failure type. |
failed_action | string | No | — | Failed action. |
failed_at_state | string | No | — | Failed state. |
failed_step | string | No | — | Failed step. |
failed_layer | string | No | — | Failed layer. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | quote | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | quote | completed | — |
* (any state) | fail | failed | — |
Business Errors ​
| Code | Message Template |
|---|---|
BILLING_ORGANIZATION_NOT_FOUND | Organization {organization_uuid} not found |
BILLING_PLATFORM_SUBSCRIPTION_NOT_FOUND | No active platform subscription found for organization |
BILLING_PENDING_FLOW_INPUT_ERROR | |
BILLING_AUTHORIZATION_REQUIRED |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "subscription.retention.billing.quote",
"initial_data": {
"organization_uuid": "value"
}
}