Get checkout

GET

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

GET

/api/v2/checkouts/:id

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.getCheckout("id");
8 }
9 main();

1 {
2   "id": "chk_7f9d8a2b3c4e5f6a7b8c9d0e",
3   "url": "https://checkout.agentpaid.io/checkout/chk_7f9d8a2b3c4e5f6a7b8c9d0e",
4   "status": "active",
5   "products": [
6     {
7       "id": "prod_1234567890abcdef"
8     }
9   ],
10   "customerId": "cus_0987654321fedcba",
11   "successUrl": "https://merchant.example.com/success",
12   "cancelUrl": "https://merchant.example.com/cancel",
13   "expiresAt": "2024-01-15T09:30:00Z",
14   "metadata": {
15     "orderNumber": "ORD-20240115-001",
16     "notes": "Priority shipping requested"
17   },
18   "createdAt": "2024-01-10T14:22:00Z",
19   "updatedAt": "2024-01-12T16:45:00Z"
20 }

Get a checkout by ID

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Response

200

idstring

urlstring

statusenum

Allowed values:

productslist of objects

customerIdstring or null

successUrlstring

cancelUrlstring or null

expiresAtdatetime or null

metadatamap from strings to any or null

createdAtdatetime

updatedAtdatetime

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error