List Checkout Sessions

GET

/api/:account_id/checkout-sessions/

GET

/api/:account_id/checkout-sessions/

$ curl https://app.paymentkit.com/api/account_id/checkout-sessions/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "items": [
3     {
4       "id": "cs_dev_x7k9m2n4p8q1",
5       "account_id": "acc_dev_x7k9m2n4p8q1",
6       "secure_token": "tok_abc123xyz789",
7       "expires_in_hours": 24,
8       "completed": false,
9       "state": "open",
10       "is_expired": false,
11       "success_url": "https://example.com/success",
12       "return_url": "https://example.com/return",
13       "card_tokenization_mode": "direct",
14       "created_at": "2024-01-15T09:30:00Z",
15       "updated_at": "2024-01-15T09:30:00Z",
16       "customer_id": "user_dev_x7k9m2n4p8q1",
17       "customer_email": "taylor@example.com",
18       "line_items": [
19         {
20           "id": "csli_dev_x7k9m2n4p8q1",
21           "product_id": "product_dev_x7k9m2n4",
22           "price_id": "price_dev_x7k9m2n4",
23           "quantity": 1,
24           "created_at": "2024-01-15T09:30:00Z",
25           "updated_at": "2024-01-15T09:30:00Z",
26           "description": "Premium subscription plan"
27         }
28       ],
29       "coupon_id": "coupon_dev_x7k9m2n4",
30       "promotion_code": "SAVE20",
31       "card_checkout_settings": {
32         "three_ds_mode": "prefer_non_3ds"
33       },
34       "cascade_status": {
35         "total_tiers": 3,
36         "tier_amounts": [
37           10000,
38           8000,
39           5000
40         ]
41       },
42       "cascade_tiers": [
43         {
44           "line_items": [
45             {
46               "price_id": "price_dev_x7k9m2n4",
47               "quantity": 1,
48               "description": "Fallback subscription plan"
49             }
50           ],
51           "processor_route_id": "proute_dev_x7k9m2n4",
52           "inline_route": {
53             "processors": [
54               {
55                 "processor_id": "proc_dev_stripe"
56               }
57             ],
58             "name": "Holiday Promo Routing",
59             "description": "Route processors for holiday discount period"
60           }
61         }
62       ],
63       "processor_route_id": "proute_dev_x7k9m2n4",
64       "inline_route": {
65         "processors": [
66           {
67             "processor_id": "proc_dev_stripe"
68           }
69         ],
70         "name": "Primary Route",
71         "description": "Main processor route for checkout sessions"
72       },
73       "setup_preferences": {},
74       "custom_fields": {},
75       "params_for_sub": {
76         "custom_fields": {}
77       },
78       "statement_descriptor_suffix": "MYSHOP"
79     }
80   ],
81   "total": 1,
82   "has_more": true
83 }

List checkout sessions with pagination.

Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency.

Pass expand=custom_fields to include each session’s custom fields.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Query parameters

expandlist of strings or nullOptional

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON string)

sortBystring or nullOptional

Field to sort by

sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Response

Successful Response

itemslist of objects

totalinteger

has_moreboolean

Errors

422

Unprocessable Entity Error