​

Retrieve a Checkout Session

​

Endpoint

• Endpoint: GET /v1/checkout/{checkoutId}
• Description: Retrieve a checkout session by its ID.
• Path Parameters:
  • checkoutId (string, required): The unique identifier of the checkout session to retrieve.
• Response:
  Copy

  {
    "id": "cs_test_123",
    "amount": 1000,
    "currency": "usd",
    "status": "completed",
    "payment_method": {
      "type": "card",
      "card": {
        "brand": "visa",
        "last4": "4242"
      }
    }
  }
  

​

Parameters

• checkoutId (string, required): The unique identifier of the checkout session to retrieve.

​

Example Request

curl -X GET https://api.example.com/v1/checkout/cs_test_123 \
  -H "Authorization: Bearer YOUR_API_KEY"

​

Example Response

{
  "id": "cs_test_123",
  "amount": 1000,
  "currency": "usd",
  "status": "completed",
  "payment_method": {
    "type": "card",
    "card": {
      "brand": "visa",
      "last4": "4242"
    }
  }
}

​

Notes

• Ensure that you have the necessary permissions to access the checkout session details.
• The response includes detailed information about the payment method used in the checkout session.

​

Errors

• 404 Not Found: The specified checkout session does not exist.
• 401 Unauthorized: Invalid or missing API key.
• 400 Bad Request: Invalid request parameters.

​

See Also

• Create a Checkout Session
• Refund a Checkout Session
• Search Checkout Sessions