Skip to main content
GET
/
v1
/
checkouts
curl -X GET 'https://api.stateset.com/v1/checkouts?status=ready_for_payment&limit=10' \
  -H "Authorization: Bearer YOUR_API_KEY"

const checkouts = await stateset.checkouts.list({
  status: 'ready_for_payment',
  limit: 10
});

checkouts = stateset.checkouts.list(
    status='ready_for_payment',
    limit=10
)

{
  "data": [
    {
      "id": "checkout_abc123",
      "buyer": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "phone_number": "+1234567890"
      },
      "status": "ready_for_payment",
      "currency": "usd",
      "line_items": [
        {
          "id": "item_123",
          "item": {
            "id": "item_123",
            "quantity": 2
          },
          "base_amount": 2000,
          "discount": 0,
          "total": 2000,
          "subtotal": 2000,
          "tax": 0
        }
      ],
      "totals": [
        {
          "type": "total",
          "display_text": "Total",
          "amount": 2250
        }
      ],
      "created_at": "2024-09-30T10:00:00Z",
      "updated_at": "2024-09-30T10:05:00Z"
    },
    {
      "id": "checkout_def456",
      "buyer": {
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "jane.smith@example.com"
      },
      "status": "ready_for_payment",
      "currency": "usd",
      "line_items": [
        {
          "id": "item_789",
          "item": {
            "id": "item_789",
            "quantity": 1
          },
          "base_amount": 5000,
          "discount": 500,
          "total": 4500,
          "subtotal": 4500,
          "tax": 0
        }
      ],
      "totals": [
        {
          "type": "total",
          "display_text": "Total",
          "amount": 4800
        }
      ],
      "created_at": "2024-09-30T09:30:00Z",
      "updated_at": "2024-09-30T09:35:00Z"
    }
  ],
  "has_more": false,
  "total_count": 2
}

{
  "success": false,
  "error": {
    "type": "invalid_request",
    "code": "INVALID_PARAMETER",
    "message": "Invalid status value provided",
    "param": "status"
  }
}
This endpoint returns a paginated list of checkout sessions. You can filter by status, buyer email, or date range.

​
Authentication

This endpoint requires a valid API key with checkouts:read permissions. 
Authorization: Bearer YOUR_API_KEY

​
Query Parameters

​
status
string
Filter by checkout status: not_ready_for_payment, ready_for_payment, completed, canceled, in_progress
​
buyer_email
string
Filter by buyer’s email address
​
created_after
string
Filter checkouts created after this ISO 8601 timestamp
​
created_before
string
Filter checkouts created before this ISO 8601 timestamp
​
limit
integer
Number of results per page (default: 20, max: 100)
​
starting_after
string
Cursor for pagination - ID of the last item from the previous page

​
Response

​
data
array
Array of checkout session objects
​
has_more
boolean
Whether there are more results available
​
total_count
integer
Total number of checkouts matching the filters
curl -X GET 'https://api.stateset.com/v1/checkouts?status=ready_for_payment&limit=10' \
  -H "Authorization: Bearer YOUR_API_KEY"

const checkouts = await stateset.checkouts.list({
  status: 'ready_for_payment',
  limit: 10
});

checkouts = stateset.checkouts.list(
    status='ready_for_payment',
    limit=10
)

{
  "data": [
    {
      "id": "checkout_abc123",
      "buyer": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "phone_number": "+1234567890"
      },
      "status": "ready_for_payment",
      "currency": "usd",
      "line_items": [
        {
          "id": "item_123",
          "item": {
            "id": "item_123",
            "quantity": 2
          },
          "base_amount": 2000,
          "discount": 0,
          "total": 2000,
          "subtotal": 2000,
          "tax": 0
        }
      ],
      "totals": [
        {
          "type": "total",
          "display_text": "Total",
          "amount": 2250
        }
      ],
      "created_at": "2024-09-30T10:00:00Z",
      "updated_at": "2024-09-30T10:05:00Z"
    },
    {
      "id": "checkout_def456",
      "buyer": {
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "jane.smith@example.com"
      },
      "status": "ready_for_payment",
      "currency": "usd",
      "line_items": [
        {
          "id": "item_789",
          "item": {
            "id": "item_789",
            "quantity": 1
          },
          "base_amount": 5000,
          "discount": 500,
          "total": 4500,
          "subtotal": 4500,
          "tax": 0
        }
      ],
      "totals": [
        {
          "type": "total",
          "display_text": "Total",
          "amount": 4800
        }
      ],
      "created_at": "2024-09-30T09:30:00Z",
      "updated_at": "2024-09-30T09:35:00Z"
    }
  ],
  "has_more": false,
  "total_count": 2
}

{
  "success": false,
  "error": {
    "type": "invalid_request",
    "code": "INVALID_PARAMETER",
    "message": "Invalid status value provided",
    "param": "status"
  }
}