Appearance
stripe.subscriptions.get_subscription ​
Get a Stripe subscription and its current status
Read a subscription. status is the field entitlement should key on: active and trialing mean entitled; past_due, canceled, unpaid and incomplete do not.
Acts on the CUSTOMER'S OWN Stripe account, authenticated via the org-scoped Stripe connection selected by cloud_connection_uuid.
Inputs:
- cloud_connection_uuid: Org-scoped Stripe connection (customer's own account).
- subscription_id: Stripe subscription ID (sub_...).
Outputs (terminal state_data):
- subscription_id: str
- status: str — active | trialing | past_due | canceled | unpaid | incomplete
- customer_id: str
- price_id: str — price on the first item
- item_id: str — subscription item id, needed to change the plan
- current_period_end: int — unix timestamp
- cancel_at_period_end: bool
- subscription_metadata: json
Connection required: cloud_connection_uuid — the organization's own Stripe account credentials; there is no platform-key fallback.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-stripe |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | Yes | — | Org-scoped Stripe connection (customer's own account) |
subscription_id | string | Yes | — | Stripe subscription ID (sub_...) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
subscription_id | string | No | — | — |
status | string | No | — | — |
customer_id | string | No | — | — |
price_id | string | No | — | — |
item_id | string | No | — | — |
current_period_end | integer | No | — | — |
cancel_at_period_end | boolean | No | — | — |
subscription_metadata | json | No | — | — |
cloud_connection_uuid | uuid | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_layer | integer | 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": "stripe.subscriptions.get_subscription",
"initial_data": {
"cloud_connection_uuid": "value",
"subscription_id": "value"
}
}