Appearance
subscription.seat_change ​
Resize user_seats / key_seats on an active subscription
Adjust seat quantities on an active subscription, in DB and in Stripe.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-subscription |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
subscription_uuid | uuid | Yes | — | OrganizationSubscription UUID |
user_seats | integer | No | — | Absolute target user seats |
key_seats | integer | No | — | Absolute target key seats |
proration_behavior | string | No | — | Stripe proration_behavior (default: always_invoice for seat increases, create_prorations otherwise) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
subscription_uuid | uuid | No | — | — |
user_seats | integer | No | — | — |
key_seats | integer | No | — | — |
user_seats_used | integer | No | — | — |
key_seats_used | integer | No | — | — |
prior | json | No | — | — |
stripe_calls | list | No | — | — |
billing_items_persisted | list | No | — | — |
proration_behavior | 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 | — | 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.seat_change",
"initial_data": {
"subscription_uuid": "value"
}
}