List checkouts

GET

https://api.agentpaid.io/api/v2/checkouts/

GET

/api/v2/checkouts/

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 async function main() {
4     const client = new PaidClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.checkouts.listCheckouts({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "id": "chk_9f8b7c6d5a4e3f2b1c0d",
5       "url": "https://checkout.agentpaid.io/checkout/chk_9f8b7c6d5a4e3f2b1c0d",
6       "status": "active",
7       "products": [
8         {
9           "id": "prod_1234567890abcdef"
10         }
11       ],
12       "customerId": "cust_9876543210fedcba",
13       "successUrl": "https://merchant.example.com/success",
14       "cancelUrl": "https://merchant.example.com/cancel",
15       "expiresAt": "2024-01-15T09:30:00Z",
16       "metadata": {
17         "orderNumber": "ORD-20240115-001",
18         "notes": "Priority shipping requested"
19       },
20       "createdAt": "2024-01-10T14:22:00Z",
21       "updatedAt": "2024-01-12T16:45:00Z"
22     }
23   ],
24   "pagination": {
25     "limit": 1,
26     "offset": 1,
27     "total": 25,
28     "hasMore": true
29   }
30 }

Get a list of checkouts for the organization

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional

statusenumOptional

Allowed values:

Response

200

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error