Create order | Paid | Documentation

AuthorizationBearer

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

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

Success response

idstring or null

namestring or null

descriptionstring or null

customerIdstring or null

organizationIdstring or null

startDatestring or null

endDatestring or null

totalAmountdouble or null

estimatedTaxdouble or null

billedAmountNoTaxdouble or null

billedTaxdouble or null

totalBilledAmountdouble or null

pendingBillingAmountdouble or null

creationStateenum or null

Allowed values:

orderLineslist of objects or null

customerobject or null

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();

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	}