get checkout
This block is part of the stripe group and was last modified in core v15.0.0.
get checkout 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.
- flow
flow - connection required
stripeconnection - session id required
valuecs_… : from checkout create, or from the
{CHECKOUT_SESSION_ID}placeholder in your success URL.
- flow
flow - connection
stripeconnection - paid
conditionTrue when the customer owes nothing :
paid, orno_payment_requiredfor a zero-total or fully discounted order. This is the pin to gate fulfilment on. - payment status
valuepaid,unpaidorno_payment_required. - session status
valueopen,completeorexpired: whether the customer finished the flow, not whether they paid. - payment intent id
value - subscription id
valueSet when the session was in subscription mode.
- customer id
value - customer email
valueThe 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
valueStripe's own message, or a sentinel like MISSING_SESSION_ID for a problem in the wiring.
- error code
valueStripe's machine-readable code, e.g.
card_declined,resource_missing. - decline code
valueWhy the bank refused, e.g.
insufficient_funds. Only set on a declined card.
payment succeeded |
check payment |
payment status |
did they pay |
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