stripe.checkout.get_session

Get a Stripe Checkout Session and its payment status

Retrieve a Checkout Session so the outcome of a payment can be confirmed server-side.

Never trust the browser's return from success_url on its own: it proves only that the shopper reached the URL. Read the session here and act on payment_status ("paid" / "unpaid" / "no_payment_required").

client_reference_id is echoed back exactly as it was set at creation, which is how a completed payment is mapped to the end-user who made it.

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).
• session_id: Checkout Session ID (cs_...).

Outputs (terminal state_data):

• session_id: str
• payment_status: str — paid | unpaid | no_payment_required
• status: str — open | complete | expired
• customer_id: str
• client_reference_id: str — the identifier set at creation
• subscription_id: str — set when mode=subscription
• amount_total: int — in the currency's smallest unit
• currency: str
• session_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)
session_id	string	Yes	—	Checkout Session ID (cs_...)

Output Schema

Field	Type	Required	Default	Description
session_id	string	No	—	—
payment_status	string	No	—	—
status	string	No	—	—
customer_id	string	No	—	—
client_reference_id	string	No	—	—
subscription_id	string	No	—	—
amount_total	integer	No	—	—
currency	string	No	—	—
session_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

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "stripe.checkout.get_session",
  "initial_data": {
    "cloud_connection_uuid": "value",
    "session_id": "value"
  }
}