get checkout

This block is part of the stripe group and was last modified in core v15.0.0.

get checkout stripeconnection v15.0.0

Reads back a Checkout Session to answer did they pay. Branch on the paid pin, not on status : a session reaches status complete in subscription and setup modes where no money moved at all.

In pins 2 + flow

flow
connection stripeconnection required
session id value required
cs_… : from checkout create, or from the {CHECKOUT_SESSION_ID} placeholder in your success URL.

Out pins 18 + flow

flow
connection stripeconnection
paid condition
True when the customer owes nothing : paid, or no_payment_required for a zero-total or fully discounted order. This is the pin to gate fulfilment on.
payment status value
paid, unpaid or no_payment_required.
session status value
open, complete or expired : whether the customer finished the flow, not whether they paid.
payment intent id value
subscription id value
Set when the session was in subscription mode.
customer id value
customer email value
The address Stripe collected on the payment page, falling back to the one the session was created with.
amount total number
currency value
reference value
line items array<object>
What was bought.
meta data object
session object
success condition
error value
Stripe's own message, or a sentinel like MISSING_SESSION_ID for a problem in the wiring.
error code value
Stripe's machine-readable code, e.g. card_declined, resource_missing.
decline code value
Why the bank refused, e.g. insufficient_funds. Only set on a declined card.

payment succeeded

check payment

payment status

did they pay

The browser comes back to your success URL with the session id in the query string, and you have to ask Stripe rather than believe the redirect. get checkout reads the session and answers on a paid condition pin, which branch uses to decide between fulfilling and showing "payment not completed". Treat this as the fast path for the page the user is looking at, and the webhook as the authority: a user who closes the tab never loads this page at all.

Version history

Introduced in v15.0.0.

Service documentation

External API reference This block wraps a third-party service. Click here for the service's own documentation of the underlying endpoint.

Back to stripe Return to the main group to view all sub-groups Back to checkout Return to the group to view all blocks within this group