v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB

Checkout Sessions

Retrieve a checkout session

Returns the checkout session, including its status, associated paymentId (present once the buyer has submitted a payment method) and custom metadata.

Prefer subscribing to checkout_session.* merchant webhooks to be notified when the session completes and the paymentId is available. This endpoint is also available for on-demand retrieval.

get/api/checkout/sessions/{sessionId}

Path parameters

sessionIdstring required

Example:sess_abc123

Unique identifier of the checkout session

Response

objectobject required

Object type discriminator

idstring required

Checkout session unique identifier

status'open' | 'expired' | 'completed' | 'failed' required

Checkout session status

type'one_time' | 'subscription' required

Checkout session type

amountnumber required

Amount in cents

currencystring required

Currency code

paymentIdstring nullable

Identifier of the payment associated with this session (present once the buyer has submitted a payment method)

metadatasobject nullable

Custom metadata attached to the session

checkoutUrlstring nullable

Hosted checkout URL for this session

expiresAtstring date-time nullable

Expiration date of the session

createdAtstring date-time required

Creation date

updatedAtstring date-time required

Last update date

Example response

{
  "id": "sess_abc123",
  "status": "open",
  "type": "one_time",
  "amount": 2999,
  "currency": "eur",
  "paymentId": "pay_abc123",
  "checkoutUrl": "https://checkout.inflowpay.com/pay/sess_abc123"
}