Book a demo

Get Checkout Session

stripe.get_checkout_session
ActionBusiness appsconnection required

Calls the Stripe API with the connection's secret key.

Retrieve one Stripe Checkout Session to see whether it was paid.

Ask about StripeAll Stripe nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Stripe
Secret shape
the Stripe secret key (sk_...)
Resolved by
config.connection_id, else node.connection_id

Configuration

1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
session_id
The Checkout Session to retrieve (cs_...). Supports {{ }} expressions.
stringYes——cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "session_id": "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u"
}

Output

One shape.

result

FieldTypeExample
id
The Checkout Session id (cs_...).
string—
url
The hosted payment page to send the customer to.
string—
status
open, complete or expired.
string—
payment_status
paid, unpaid or no_payment_required.
string—
mode
payment, setup or subscription.
string—
amount_total
Total after discounts and tax, in the minor unit.
number—
amount_subtotal
Total before discounts and tax, in the minor unit.
number—
currency
Three-letter lowercase ISO currency code.
string—
customer
The customer the session created or used, or null.
string—
customer_email
The email prefilled on the page, or null.
string—
client_reference_id
Your own reference for this session, or null.
string—
payment_intent
The PaymentIntent the session created, or null.
string—
subscription
The subscription the session created, or null.
string—
expires_at
When the session expires, Unix seconds.
number—
created
Creation time, as a Unix timestamp in seconds.
number—
{
  "amount_subtotal": 0,
  "amount_total": 0,
  "client_reference_id": "",
  "created": 0,
  "currency": "",
  "customer": "",
  "customer_email": "",
  "expires_at": 0,
  "id": "",
  "mode": "",
  "payment_intent": "",
  "payment_status": "",
  "status": "",
  "subscription": "",
  "url": ""
}

Related Stripe nodes

Templates that use Stripe

Solutions with Stripe

See Get Checkout Session run in a workflow.

In a technical demo we add the Stripe connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales