Update order lines | Paid

const url = 'https://api.agentpaid.io/api/v1/orders/orderId/lines';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"lines":[{"name":"Premium Support Package","description":"Premium support package for Acme, Inc. including 24/7 support and dedicated account manager.","agentExternalId":"acme-agent-001"},{"name":"Cloud Storage Plan","description":"Cloud storage plan with 1TB capacity for Acme, Inc.","agentExternalId":"acme-agent-002"}]}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": "order-7890",
  "name": "Acme Corporate Order Q2 2024",
  "description": "Quarter 2 order for Acme, Inc. covering support and storage services.",
  "customerId": "cust-12345",
  "organizationId": "org-67890",
  "startDate": "2024-04-01",
  "endDate": "2024-06-30",
  "totalAmount": 12500,
  "estimatedTax": 1000,
  "billedAmountNoTax": 11500,
  "billedTax": 1000,
  "totalBilledAmount": 12500,
  "pendingBillingAmount": 0,
  "creationState": "active",
  "orderLines": [
    {
      "id": "line-001",
      "orderId": "order-7890",
      "agentId": "agent-001",
      "name": "Premium Support Package",
      "description": "Premium support package for Acme, Inc. including 24/7 support and dedicated account manager.",
      "startDate": "2024-04-01",
      "endDate": "2024-06-30",
      "totalAmount": 8000,
      "billedAmountWithoutTax": 7400,
      "billedTax": 600,
      "totalBilledAmount": 8000,
      "creationState": "active",
      "agent": {
        "id": "agent-001",
        "organizationId": "org-67890",
        "name": "Acme Premium Support",
        "active": true,
        "externalId": "acme-agent-001",
        "description": "Agent providing premium support services.",
        "agentCode": "SUPP-PRM-001",
        "agentAttributes": [
          {
            "name": "support_hours",
            "active": true,
            "pricing": {
              "taxable": true,
              "chargeType": "recurring",
              "pricingModel": "PerUnit",
              "billingFrequency": "monthly",
              "pricePoints": {},
              "eventName": "support_hour",
              "creditCost": 0
            }
          }
        ]
      },
      "orderLineAttributes": [
        {
          "agentAttributeId": "attr-001",
          "quantity": 160,
          "currency": "USD",
          "pricing": {
            "eventName": "support_hour",
            "chargeType": "recurring",
            "pricePoint": {
              "currency": "USD",
              "unitPrice": 46.25,
              "minQuantity": 1,
              "tiers": [
                {
                  "lowerBound": 1,
                  "upperBound": 200,
                  "price": 46.25
                }
              ]
            },
            "pricingModel": "PerUnit",
            "billingFrequency": "monthly"
          }
        }
      ]
    }
  ],
  "customer": {
    "id": "cust-12345",
    "organizationId": "org-67890",
    "name": "Acme, Inc.",
    "externalId": "ACME-EXT-001",
    "phone": "+1-555-123-4567",
    "employeeCount": 5000,
    "annualRevenue": 250000000,
    "taxExemptStatus": "none",
    "creationSource": "api",
    "creationState": "active",
    "website": "https://www.acme.com",
    "billingAddress": {
      "line1": "123 Acme Way",
      "city": "Metropolis",
      "state": "NY",
      "zipCode": "10001",
      "country": "USA",
      "line2": "Suite 400"
    },
    "metadata": {}
  }
}

Authentication

AuthorizationBearer

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

Path parameters

orderIdstringRequired

Request

This endpoint expects an object.

lineslist of objectsOptional

Response

Success response

idstring

namestring

descriptionstring

customerIdstring

organizationIdstring

startDatestring

endDatestring

totalAmountdouble

estimatedTaxdouble

billedAmountNoTaxdouble

billedTaxdouble

totalBilledAmountdouble

pendingBillingAmountdouble

creationStateenum

Allowed values:

orderLineslist of objects

customerobject