Skip to main content
POST
/
v2
/
checkout-sessions
Create a Checkout Session
curl --request POST \
  --url https://api.dots.dev/api/v2/checkout-sessions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "line_items": [
    {
      "price_data": {
        "currency": "usd",
        "amount": 123,
        "product_data": {
          "name": "<string>",
          "description": "<string>",
          "images": [
            "<string>"
          ],
          "metadata": {}
        }
      },
      "quantity": 123
    }
  ],
  "success_url": "<string>",
  "mode": "payment",
  "customer_email": "[email protected]",
  "client_reference_id": "<string>",
  "cancel_url": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_in": 10800,
  "metadata": {}
}
'
{
  "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.

Body

application/json
​
line_items
object[]
required
​
success_url
string<uri>
required
​
mode
enum<string>
required
Available options:
payment
​
customer_email
string<email>
​
client_reference_id
string
​
cancel_url
string<uri>
​
user_id
string<uuid>

Supply a Dots user ID in place of a customer ID

​
customer_id
string<uuid>
​
expires_in
integer
default:10800
Required range: 0 <= x <= 10800
​
metadata
object

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