Create order

POST

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

POST

/api/v1/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.create({
8         name: "Acme Order",
9         startDate: "2025-01-01",
10         currency: "USD",
11         customerExternalId: "acme-inc",
12         description: "Acme Order is an order for Acme, Inc.",
13         endDate: "2026-01-01",
14     });
15 }
16 main();

201Simple order with auto-generated attributes

1 {
2   "id": "63fd642c-569d-44f9-8d67-5cf4944a16cc",
3   "name": "Acme Order",
4   "description": "Acme Order is an order for Acme, Inc.",
5   "startDate": "2025-01-01",
6   "endDate": "2026-01-01",
7   "customerExternalId": "acme-inc",
8   "currency": "USD",
9   "lines": [
10     {
11       "agentExternalId": "acme-agent",
12       "name": "Order Line One"
13     },
14     {
15       "agentExternalId": "acme-agent-2",
16       "name": "Order Line Two"
17     }
18   ]
19 }

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

startDatestringRequired

currencystringRequired

customerIdstringOptional

customerExternalIdstringOptional

billingContactIdstringOptional

descriptionstringOptional

endDatestringOptional

planIdstringOptionalformat: "uuid"

Optional plan ID to associate with this order

orderLineslist of objectsOptional

Response

Success response

idstring

namestring

descriptionstring

customerIdstring

organizationIdstring

startDatestring

endDatestring

totalAmountdouble

estimatedTaxdouble

billedAmountNoTaxdouble

billedTaxdouble

totalBilledAmountdouble

pendingBillingAmountdouble

creationStateenum

orderLineslist of objects

customerobject