Activate order | Paid | Documentation

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

{
  "id": "a3f47c2e-9b1d-4f3a-8c2e-1d2f3b4a5c6d",
  "customerId": "c1234567-89ab-4def-0123-456789abcdef",
  "billingCustomerId": "b9876543-21fe-4dc3-ba98-76543210fedc",
  "billingContactIds": [
    "bc456789-0123-4def-89ab-cdef01234567"
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-04-20T14:45:00Z",
  "endDate": "2025-01-15T09:30:00Z",
  "name": "Premium Subscription Plan",
  "startDate": "2024-01-15T09:30:00Z",
  "subscriptionTerms": 12,
  "billedAmountNoTax": 1200,
  "billedTax": 96,
  "estimatedTax": 96,
  "orderAmount": 1296,
  "pendingBillingAmount": 0,
  "totalAmount": 1296,
  "totalBilledAmount": 1296,
  "creationState": "active",
  "paymentTerms": "Net 30",
  "number": 1001,
  "metadata": {
    "source": "dashboard",
    "campaign": "spring_promo"
  },
  "showPaymentLink": true,
  "showBankDetails": true,
  "autoPostInvoices": true,
  "autoSendBillingEmails": true,
  "autoSendPaymentEmails": true,
  "version": 3,
  "billingFrequencyOverridden": true,
  "purchaseOrderReference": "PO-2024-0456",
  "billingFrequencyOverride": {
    "frequency": "monthly",
    "customMonths": 1
  }
}

Activate a draft order by ID. Activation starts billing for the order using the same validation and side effects as the dashboard activation flow.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Response

200

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

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

purchaseOrderReferencestring or null

billingFrequencyOverrideobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error