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.activate("orderId");
}
main();

{
  "id": "ord_9f8b7c6d5e4a3b2c1d0e",
  "name": "Premium Subscription Plan",
  "description": "Activation of the premium annual subscription for customer",
  "customerId": "cust_1234567890abcdef",
  "organizationId": "org_abcdef1234567890",
  "startDate": "2024-07-01T00:00:00Z",
  "endDate": "2025-06-30T23:59:59Z",
  "totalAmount": 1200,
  "estimatedTax": 96,
  "billedAmountNoTax": 1104,
  "billedTax": 96,
  "totalBilledAmount": 1200,
  "pendingBillingAmount": 0,
  "creationState": "active",
  "orderLines": [
    {
      "id": "ol_abcdef1234567890",
      "orderId": "ord_9f8b7c6d5e4a3b2c1d0e",
      "agentId": "agent_0011223344556677",
      "name": "Annual License Fee",
      "description": "License fee for the premium software package",
      "startDate": "2024-07-01T00:00:00Z",
      "endDate": "2025-06-30T23:59:59Z",
      "totalAmount": 1200,
      "billedAmountWithoutTax": 1104,
      "billedTax": 96,
      "totalBilledAmount": 1200,
      "creationState": "active",
      "agent": {
        "id": "agent_0011223344556677",
        "organizationId": "org_abcdef1234567890",
        "name": "Software Licensing Agent",
        "active": true,
        "externalId": "EXT-AGENT-7890",
        "description": "Handles licensing and subscription management",
        "agentCode": "SLA-2024",
        "agentAttributes": [
          {
            "name": "License Fee",
            "active": true,
            "pricing": {
              "taxable": true,
              "chargeType": "recurring",
              "pricingModel": "PerUnit",
              "billingFrequency": "annual",
              "pricePoints": {
                "default": {
                  "unitPrice": 1200,
                  "minQuantity": 1,
                  "includedQuantity": 0,
                  "tiers": []
                }
              },
              "eventName": "AnnualLicense",
              "creditCost": 0
            }
          }
        ]
      },
      "orderLineAttributes": [
        {
          "agentAttributeId": "attr_1234abcd5678efgh",
          "quantity": 1,
          "currency": "USD",
          "pricing": {
            "eventName": "AnnualLicense",
            "chargeType": "recurring",
            "pricePoint": {
              "currency": "USD",
              "unitPrice": 1200,
              "minQuantity": 1,
              "tiers": [
                {
                  "lowerBound": 1,
                  "upperBound": 10,
                  "price": 1200
                }
              ]
            },
            "pricingModel": "PerUnit",
            "billingFrequency": "annual"
          }
        }
      ]
    }
  ],
  "customer": {
    "id": "cust_1234567890abcdef",
    "organizationId": "org_abcdef1234567890",
    "name": "Acme Corporation",
    "externalId": "ACME-2024",
    "phone": "+1-555-123-4567",
    "employeeCount": 250,
    "annualRevenue": 50000000,
    "taxExemptStatus": "none",
    "creationSource": "api",
    "creationState": "active",
    "website": "https://www.acmecorp.com",
    "billingAddress": {
      "line1": "123 Business Rd",
      "city": "Metropolis",
      "state": "NY",
      "zipCode": "10001",
      "country": "USA",
      "line2": "Suite 400"
    },
    "metadata": {
      "industry": "Technology",
      "accountManager": "jane.doe@acmecorp.com"
    }
  }
}

Authentication

AuthorizationBearer

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

Path parameters

orderIdstringRequired

Response

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