Retrieve sessionGET

OpenStock Docs

GET

/api/checkout-api/sessions/{session_id}

checkout_api

Fetches a single session. Pending sessions past their expiry are marked expired when read.

Authorization#

AuthorizationBearer <token>

In: header. A store API key starting with sk_ that has the checkout_api permission.

Path parameters#

session_idrequiredstring

The cs_… ID returned when the session was created.

Responses#

200The session.
404No session with that ID belongs to this store.
401Missing, malformed, disabled or expired API key.

curl -X GET "https://openstock.dev/api/checkout-api/sessions/cs_9f2c4e1a7b3d4c5e8f90a1b2c3d4e5f6" \
  -H "Authorization: Bearer $OPENSTOCK_API_KEY"

The session.

{
  "id": "cs_9f2c4e1a7b3d4c5e8f90a1b2c3d4e5f6",
  "url": "https://your-store.openstock.dev/checkout?session=cs_9f2c4e1a7b3d4c5e8f90a1b2c3d4e5f6",
  "status": "pending",
  "total_amount": 29.99,
  "currency": "USD",
  "customer_email": "jane@example.com",
  "customer_name": null,
  "payment_method": null,
  "metadata": {
    "orderNumber": "ORD-4821"
  },
  "client_reference_id": null,
  "line_items": [
    {
      "name": "Premium License",
      "description": "",
      "price": 29.99,
      "quantity": 1,
      "image": null,
      "metadata": {}
    }
  ],
  "expires_at": "2026-03-04T18:50:00.000Z",
  "created_at": "2026-03-04T18:20:00.000Z"
}