use-shopping-cart logouse-shopping-cart

redirectToCheckout()

Sends the browser to Stripe Checkout using the session.url your server created. It's a standalone function, not a cart method, and needs no Stripe key in the browser.

Signature

function redirectToCheckout(sessionUrl: string): void

Parameters

  • sessionUrl (string, required): the session.url returned by stripe.checkout.sessions.create() on your server

How It Works

  1. Your server creates a Stripe Checkout Session
  2. The server returns session.url
  3. Call redirectToCheckout(sessionUrl) on the client
  4. The browser navigates to Stripe's checkout page

Basic Usage

import { redirectToCheckout, useShoppingCart } from 'use-shopping-cart'

function CheckoutButton() {
  const cartDetails = useShoppingCart((cart) => cart.cartDetails)
  const cartCount = useShoppingCart((cart) => cart.cartCount)

  const handleCheckout = async () => {
    const response = await fetch('/api/checkout', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ cartDetails })
    })
    const { sessionUrl } = await response.json()

    redirectToCheckout(sessionUrl)
  }

  return (
    <button onClick={handleCheckout} disabled={cartCount === 0}>
      Proceed to Checkout
    </button>
  )
}

With Loading States

import { useState } from 'react'
import { redirectToCheckout, useShoppingCart } from 'use-shopping-cart'

function CheckoutButton() {
  const cartDetails = useShoppingCart((cart) => cart.cartDetails)
  const cartCount = useShoppingCart((cart) => cart.cartCount)
  const [isLoading, setIsLoading] = useState(false)
  const [error, setError] = useState<string | null>(null)

  const handleCheckout = async () => {
    setIsLoading(true)
    setError(null)

    try {
      const response = await fetch('/api/checkout', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify({ cartDetails })
      })
      if (!response.ok) throw new Error('Failed to create checkout session')

      const { sessionUrl } = await response.json()
      redirectToCheckout(sessionUrl)
    } catch (err) {
      setError(err instanceof Error ? err.message : 'Checkout failed')
      setIsLoading(false)
    }
  }

  return (
    <div>
      <button onClick={handleCheckout} disabled={cartCount === 0 || isLoading}>
        {isLoading ? 'Redirecting...' : 'Checkout'}
      </button>
      {error && <p className="error">{error}</p>}
    </div>
  )
}

Server Endpoint Example

Your server endpoint creates the checkout session and returns session.url. Build line_items with validateCartItems, which takes prices from your inventory instead of trusting the cartDetails the browser sent:

// app/api/checkout/route.ts (Next.js App Router)
import { NextRequest, NextResponse } from 'next/server'
import Stripe from 'stripe'
import { validateCartItems } from 'use-shopping-cart/utilities'
import { inventory } from '@/data/products'

const stripe = new Stripe(process.env.STRIPE_SECRET_KEY!)

export async function POST(req: NextRequest) {
  try {
    const { cartDetails } = await req.json()
    const line_items = validateCartItems(inventory, cartDetails)

    const session = await stripe.checkout.sessions.create({
      mode: 'payment',
      line_items,
      success_url: `${req.nextUrl.origin}/success?session_id={CHECKOUT_SESSION_ID}`,
      cancel_url: req.nextUrl.origin
    })

    return NextResponse.json({ sessionUrl: session.url })
  } catch (error) {
    console.error('Checkout error:', error)
    return NextResponse.json(
      { error: 'Failed to create checkout session' },
      { status: 500 }
    )
  }
}

Errors

CodeCause
INVALID_CHECKOUT_URLsessionUrl isn't an http(s) URL, for example a session ID (cs_...)
NOT_IN_BROWSERcalled on the server

Migrating from Session IDs

Stripe removed stripe.redirectToCheckout({ sessionId }) from Stripe.js, so session IDs are no longer supported. Return session.url from your server instead of session.id, and drop the stripe prop from <CartProvider>.

See Also

On this page

Shopping Cart

Your cart is empty

Try the interactive demos on the docs pages!