API Reference · Checkout Sessions

Retrieve a checkout session

Fetches a checkout session by id.

GET/v1/checkout/sessions/:id

Accepts either a secret or publishable key. The hosted widget uses this path with a publishable key to poll for session status before redirecting.

Returnscheckout_session object

Path parameters

idstringRequired

Session id (`cs_…`).

Errors

404

resource_missing

No session exists with that id in the current livemode.

Request

curl https://lunipay.io/api/v1/checkout/sessions/cs_01JRZK8WV3FYMPEQRXJ9HA5NTB \
  -H "Authorization: Bearer sk_test_YOUR_KEY"

Response

{
  "id": "cs_01JRZK8WV3FYMPEQRXJ9HA5NTB",
  "object": "checkout_session",
  "livemode": false,
  "status": "OPEN",
  "payment_status": "unpaid",
  "amount_cents": 5000,
  "currency": "usd",
  "success_url": "https://example.com/thanks?session_id={CHECKOUT_SESSION_ID}",
  "cancel_url": "https://example.com/cart",
  "customer_id": null,
  "customer_email": null,
  "line_items": null,
  "payment_intent_id": null,
  "payment_id": null,
  "metadata": {
    "order_id": "ORD-9821"
  },
  "expires_at": 1713187200,
  "completed_at": null,
  "url": "https://lunipay.io/checkout/cs_01JRZK8WV3FYMPEQRXJ9HA5NTB",
  "created": 1713100800,
  "updated": 1713100800
}