Get order | Paid | Documentation

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

{
  "id": "ord_9f8b7c6d5e4a3b2c1d0e",
  "customerId": "cust_1234567890abcdef",
  "billingCustomerId": "billcust_abcdef1234567890",
  "billingContactIds": [
    "contact_9876543210fedcba"
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-02-01T14:45:00Z",
  "endDate": "2024-12-31T23:59:59Z",
  "name": "Premium Subscription Plan",
  "startDate": "2024-01-01T00:00: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": "web",
    "campaign": "spring_promo"
  },
  "showPaymentLink": true,
  "showBankDetails": false,
  "version": 3
}

Get an order by ID

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

Allowed values:

paymentTermsstring or null

numberdouble

metadatamap from strings to any or null

showPaymentLinkboolean or null

showBankDetailsboolean or null

versioninteger

Authentication

Path parameters

Response

Errors