Customize your success page

Learn how to display a confirmation page with your customer's order information.

First build an integration to accept a payment with Checkout before using this guide.

You can use the details from a Checkout Session to display an order confirmation page for your customer (for example, their name or payment amount) after the payment. To use the details from a Checkout Session:

Modify the success_url to pass the Checkout Session ID to the client side.
Look up the Checkout Session using the ID on your success page.
Use the Checkout Session to customize what’s displayed on your success page.

Modify the success URL
Server-side

Add the {CHECKOUT_SESSION_ID} template variable to the success_url when you create the Checkout Session. Note that this is a literal string and must be added exactly as you see it here. Do not substitute it with a Checkout Session ID—this happens automatically after your customer pays and is redirected to the success page.

session = Stripe::Checkout::Session.create(
  success_url: "http://yoursite.com/order/success",
  success_url: "http://yoursite.com/order/success?session_id={CHECKOUT_SESSION_ID}",
  # other options...,
)

Create the success page
Server-side

Next, look up the Checkout Session using the ID and create a success page to display the order information. This example prints out the customer’s name:

# This example sets up an endpoint using the Sinatra framework.
# Watch this video to get started: https://youtu.be/8aA9Enb8NVc.

# Set your secret key. Remember to switch to your live secret key in production.
# See your keys here: https://dashboard.stripe.com/apikeys
Stripe.api_key = 'sk_test_4eC39HqLyjWDarjtT1zdp7dc'

require 'sinatra'

get '/order/success' do
  session = Stripe::Checkout::Session.retrieve(params[:session_id])
  customer = Stripe::Customer.retrieve(session.customer)

  "<html><body><h1>Thanks for your order, #{{customer.name}}!</h1></body></html>"
end

Test the integration

Click your checkout button and fill in the customer name (for example, “Jenny Rosen”) and the remaining payment details.
Click Pay.

You should be redirected to the success page, and see Thanks for your order, Jenny Rosen!

▗▄ ▄▟█ █▀▀ ▗▟████▙▖ ██████ ███▗▟█ ███ ███▗▟██▙▖ ▗▟█████▙▖ ███▖ ▀▀ ███ ███▀▀▀ ███ ███▀ ███ ███ ███ ▝▜████▙▖ ███ ███ ███ ███ ███ █████████ ▄▄ ▝███ ███ ▄ ███ ███ ███▄ ███ ███ ▄▄ ▝▜████▛▘ ▝▜███▛ ███ ███ ███▝▜██▛▘ ▝▜█████▛▘ ███ ▀▘ Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Login to Stripe docs and press Control + Backtick on your keyboard to start managing your Stripe resources in test mode. - View supported commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g. )

Customize your success page

Modify the success URLServer-side

Create the success pageServer-side

Test the integration

Modify the success URL
Server-side

Create the success page
Server-side