---
title: "Activate order"
method: POST
path: "/orders/{orderId}/activate"
tags: ["orders"]
---

# Activate order

`POST /orders/{orderId}/activate`

## Request

- Base URL: `https://api.agentpaid.io/api/v1`
- URL: `https://api.agentpaid.io/api/v1/orders/{orderId}/activate`
- Auth: HTTP bearer

## Path parameters

- `orderId` string, required

## Response `200`

Success response

- Order
  - `id` string
  - `name` string
  - `description` string
  - `customerId` string
  - `organizationId` string
  - `startDate` string
  - `endDate` string
  - `totalAmount` number, double
  - `estimatedTax` number, double
  - `billedAmountNoTax` number, double
  - `billedTax` number, double
  - `totalBilledAmount` number, double
  - `pendingBillingAmount` number, double
  - `creationState` 'active' | 'draft'
  - `orderLines` OrderLine[]
    - `id` string
    - `orderId` string
    - `agentId` string
    - `name` string
    - `description` string
    - `startDate` string
    - `endDate` string
    - `totalAmount` number, double
    - `billedAmountWithoutTax` number, double
    - `billedTax` number, double
    - `totalBilledAmount` number, double
    - `creationState` 'active' | 'draft'
    - `agent` Agent
      - `id` string, required
      - `externalId` string
      - `organizationId` string, required
      - `name` string, required
      - `description` string
      - `active` boolean, required
      - `agentCode` string
      - `agentAttributes` AgentAttribute[]
        - `name` string, required
        - `active` boolean, required
        - `pricing` Pricing, required
          - `eventName` string
          - `taxable` boolean, required
          - `creditCost` number, double
          - `chargeType` 'oneTime' | 'recurring' | 'usage' | 'seatBased', required
          - `pricingModel` 'PerUnit' | 'VolumePricing' | 'GraduatedPricing' | 'PrepaidCredits', required
          - `billingFrequency` 'monthly' | 'quarterly' | 'annual', required
          - `pricePoints` object, required
    - `orderLineAttributes` OrderLineAttribute[]
      - `agentAttributeId` string
      - `quantity` number, double
      - `currency` string
      - `pricing` OrderLineAttributePricing
        - `eventName` string
        - `chargeType` 'oneTime' | 'recurring' | 'usage' | 'seatBased'
        - `pricePoint` PricePoint
          - `currency` string
          - `unitPrice` number, double
          - `minQuantity` number, double
          - `tiers` Tier[]
            - `lowerBound` number, double
            - `upperBound` number, double
            - `price` number, double
        - `pricingModel` 'PerUnit' | 'VolumePricing' | 'GraduatedPricing' | 'PrepaidCredits'
        - `billingFrequency` 'monthly' | 'quarterly' | 'annual'
  - `customer` Customer
    - `id` string, required
    - `organizationId` string, required
    - `name` string, required
    - `externalId` string
    - `phone` string
    - `employeeCount` number, double
    - `annualRevenue` number, double
    - `taxExemptStatus` 'none' | 'exempt' | 'reverse'
    - `creationSource` 'manual' | 'api' | 'crm' | 'other'
    - `creationState` 'active' | 'draft'
    - `website` string
    - `billingAddress` Address
      - `line1` string, required
      - `line2` string
      - `city` string, required
      - `state` string, required
      - `zipCode` string, required
      - `country` string, required
    - `metadata` CustomerMetadata: Flexible JSON field for storing custom metadata about the customer

---

[API](https://skmtc.dev/paid/apis/paid-2.md) - [All operations](https://skmtc.dev/paid/apis/paid-2/llms.txt) - [OpenAPI document](https://skmtc.dev/paid/apis/paid-2/revisions/dbdf4a60ed27?raw)