Skip to main content
GET
/
v2
/
checkout-sessions
/
{checkout_session_id}
Retrieve a Checkout Session
curl --request GET \
  --url https://api.dots.dev/api/v2/checkout-sessions/{checkout_session_id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "open",
  "payment_intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success_url": "<string>",
  "cancel_url": "<string>",
  "checkout_session_url": "<string>",
  "client_reference_id": "<string>",
  "expiry": "2023-11-07T05:31:56Z",
  "metadata": {},
  "line_items": [
    {
      "quantity": 123,
      "price_id": "<string>"
    }
  ],
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_email": "[email protected]",
  "amount_total": 123
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
checkout_session_id
string
required

ID of the checkout session to retrieve

Response

200 - application/json

OK

​
id
string<uuid>
​
status
enum<string>
Available options:
open,
complete,
expired
​
payment_intent_id
string<uuid>
​
success_url
string<uri>
​
cancel_url
string<uri>
​
checkout_session_url
string<uri>
​
client_reference_id
string
​
expiry
string<date-time>
​
metadata
object
​
line_items
object[]
​
created
string<date-time>
​
updated
string<date-time>
​
customer_id
string<uuid>

payment-customer ID

​
customer_email
string<email>
​
amount_total
integer