Create a new order | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.orders.createOrder({
        customerId: "cust_987654321",
    });
}
main();

{
  "id": "ord_123456789",
  "customerId": "cust_987654321",
  "billingCustomerId": "billcust_123456",
  "billingContactIds": [
    "contact_456789"
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "endDate": "2024-12-31T23:59:59Z",
  "name": "Enterprise Software Subscription",
  "startDate": "2024-01-15T09:30:00Z",
  "subscriptionTerms": 12,
  "billedAmountNoTax": 1200,
  "billedTax": 96,
  "estimatedTax": 96,
  "orderAmount": 1296,
  "pendingBillingAmount": 0,
  "totalAmount": 1296,
  "totalBilledAmount": 1296,
  "creationState": "draft",
  "paymentTerms": "Net 30",
  "number": 1001,
  "metadata": {},
  "showPaymentLink": true,
  "showBankDetails": true,
  "autoPostInvoices": true,
  "autoSendBillingEmails": true,
  "autoSendPaymentEmails": true,
  "version": 1,
  "billingFrequencyOverridden": true,
  "billingFrequencyOverride": {
    "frequency": "monthly",
    "customMonths": 1
  }
}

Creates a new order for the organization

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Request

Body

customerIdstringRequired

billingCustomerIdstringOptional

billingContactIdslist of stringsOptional

namestringOptional

startDatedatetimeOptional

endDatedatetimeOptional

subscriptionTermsintegerOptional

creationStateenumOptional

Allowed values:

billingAnchorintegerOptional1-31

Day of month for billing anchor (1-31). Defaults to start date day if not provided.

paymentTermsstringOptional

externalIdstringOptional

metadatamap from strings to anyOptional

currencystringOptional

autoPostInvoicesbooleanOptional

autoSendBillingEmailsbooleanOptional

autoSendPaymentEmailsbooleanOptional

lineslist of objectsOptional

billingFrequencyOverrideobjectOptional

Response

201

idstring

customerIdstring

billingCustomerIdstring or null

billingContactIdslist of strings

createdAtdatetime

updatedAtdatetime

endDatedatetime or null

namestring

startDatedatetime

subscriptionTermsinteger or null

billedAmountNoTaxdouble

billedTaxdouble

estimatedTaxdouble

orderAmountdouble

pendingBillingAmountdouble

totalAmountdouble

totalBilledAmountdouble

creationStateenum

Allowed values:

paymentTermsstring or null

numberdouble

metadatamap from strings to any or null

showPaymentLinkboolean or null

showBankDetailsboolean or null

autoPostInvoicesboolean or null

autoSendBillingEmailsboolean or null

autoSendPaymentEmailsboolean or null

versioninteger

billingFrequencyOverriddenboolean

billingFrequencyOverrideobject

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error