List orders

GET

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

GET

/api/v2/orders/

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.orders.listOrders({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "id": "ord_9f8b7c6d5e4a3b2c1d0e",
5       "customerId": "cust_1234567890abcdef",
6       "billingCustomerId": "billcust_abcdef1234567890",
7       "billingContactIds": [
8         "contact_9876543210fedcba"
9       ],
10       "createdAt": "2024-01-15T09:30:00Z",
11       "updatedAt": "2024-02-01T12:45:00Z",
12       "endDate": "2024-12-31T23:59:59Z",
13       "name": "Annual Software Subscription",
14       "startDate": "2024-01-01T00:00:00Z",
15       "subscriptionTerms": 12,
16       "billedAmountNoTax": 1200,
17       "billedTax": 96,
18       "estimatedTax": 96,
19       "orderAmount": 1296,
20       "pendingBillingAmount": 0,
21       "totalAmount": 1296,
22       "totalBilledAmount": 1296,
23       "creationState": "active",
24       "paymentTerms": "Net 30",
25       "number": 1001,
26       "metadata": {
27         "department": "IT",
28         "priority": "high"
29       },
30       "showPaymentLink": true,
31       "showBankDetails": false,
32       "version": 3
33     }
34   ],
35   "pagination": {
36     "limit": 10,
37     "offset": 0,
38     "total": 25,
39     "hasMore": true
40   }
41 }

Get a list of orders for the organization

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional

Response

200

datalist of objects

paginationobject

Authentication

Query parameters

Response

Errors