Checkouts
The checkouts endpoint provides a read-only view of pending (abandoned) checkouts for admin use. Each checkout includes the customer email, cart total, item count, and recovery email status — showing which step of the 3-step cart recovery sequence has been sent.
This endpoint is separate from the storefront-facing /v1/checkout endpoints used to create and manage individual checkout sessions.
Base URL: https://api.hydrajs.dev
Endpoints
| Method | Path | Auth | Description |
|---|---|---|---|
GET |
/v1/checkouts |
Secret | List abandoned checkouts |
List abandoned checkouts
GET /v1/checkouts
Returns a cursor-paginated list of pending checkouts. Supports filtering by recovery step and searching by customer email.
Query parameters
| Parameter | Type | Description |
|---|---|---|
limit |
integer | Results per page (1–100, default 25) |
cursor |
string | Pagination cursor from a previous response |
recovery_step |
string | Filter by recovery step: 0, 1, 2, 3 |
search |
string | Search by customer email (substring match) |
sort |
string | Sort field: created_at (default), updated_at |
order |
string | Sort direction: asc, desc (default) |
Request
curl "https://api.hydrajs.dev/v1/checkouts?recovery_step=0&limit=10" \
-H "Authorization: Bearer sk_live_YOUR_KEY"
Response 200
{
"data": [
{
"id": "chk_abc123def456ghi789",
"customer_email": "jane@example.com",
"customer_id": "cus_xyz789abc123def456",
"subtotal": 5998,
"currency": "USD",
"item_count": 2,
"recovery_step": 0,
"recovery_opted_out": false,
"created_at": "2026-09-03T10:30:00.000Z"
}
],
"pagination": {
"cursor": "eyJ0IjoiMjAyNi...",
"has_more": false,
"total": 1
}
}
The checkout list item object
| Field | Type | Description |
|---|---|---|
id |
string | Unique ID (prefix: chk_) |
customer_email |
string | Customer’s email address |
customer_id |
string | null | Customer ID if registered, null for guests |
subtotal |
integer | null | Cart subtotal in minor units (cents) |
currency |
string | null | Currency code (e.g. USD) |
item_count |
integer | Number of items in the cart |
recovery_step |
integer | Recovery email step sent: 0 (none), 1, 2, 3 |
recovery_opted_out |
boolean | Whether the customer unsubscribed from recovery emails |
created_at |
string | ISO 8601 timestamp when checkout was created |