Pax8 Order Management
Overview
Orders in Pax8 are the mechanism for provisioning new cloud subscriptions for client companies. When an MSP needs to set up a new product for a client -- whether it is Microsoft 365 licenses, a security tool, or backup solution -- they create an order. The order contains one or more line items, each specifying a product, quantity, and billing term. Once submitted, the order is processed and, upon successful provisioning, creates one or more subscriptions.
Anti-triggers
- What the client currently has — an order is a historical purchase
event; the live licence state is
pax8-subscriptions. An order that
provisioned twelve months ago tells you nothing about today's seat
count.
- What the MSP owes for it — orders do not carry the charge; use
pax8-invoices.
- A quote to the client — a Pax8 order is the MSP buying from the
distributor, not the client buying from the MSP. Client-facing quoting
lives in
connectwise-cpq-quotes or autotask-quotes.
- A purchase order in the accounting system — use
qbo-expenses or xero-invoices; a Pax8 order is not a PO on
the books.
MCP Tools
Available Tools
| Tool |
Description |
Key Parameters |
pax8-list-orders |
List orders with optional filters |
page, size, companyId |
pax8-get-order-by-uuid |
Get a single order's details |
uuid (required) |
List Orders
Call pax8-list-orders with optional parameters:
- Filter by company: Set
companyId to a company UUID
- Paginate: Set
page (0-based) and size (up to 200)
Example: List all orders for a company:
pax8-list-orders with companyId=a1b2c3d4-..., size=200
Example: List recent orders (first page):
pax8-list-orders with page=0, size=50
Get a Single Order
Call pax8-get-order-by-uuid with the uuid parameter.
Example:
pax8-get-order-by-uuid with uuid=o1r2d3e4-r5s6-7890-abcd-ef1234567890
Key Concepts
Order Lifecycle
Create Order --> Processing --> Provisioning --> Completed --> Subscription Created
|
PendingManual
(vendor action needed)
Order States
| State |
Description |
Submitted |
Order received and being processed |
Processing |
Order is being provisioned |
Completed |
Order fulfilled; subscriptions created |
Failed |
Order could not be provisioned |
PendingApproval |
Awaiting MSP approval (self-service orders) |
Cancelled |
Order was cancelled before completion |
Line Items
Each order contains one or more line items. Each line item corresponds to a single product:
| Concept |
Description |
| Product |
The cloud software being ordered |
| Quantity |
Number of seats/licenses |
| Billing Term |
Monthly, Annual, or Triennial |
| Provision Start Date |
When the subscription should begin |
Order-to-Subscription Flow
- MSP creates an order with line items for one or more products
- Pax8 processes the order and initiates provisioning with the vendor
- Provisioning completes (automated: seconds/minutes; manual: hours/days)
- Subscription is created and becomes Active
- Billing begins on the provision start date
Field Reference
Order Fields
| Field |
Type |
Required |
Description |
id |
UUID |
System |
Order unique identifier |
companyId |
UUID |
Yes |
Company the order is for |
lineItems |
array |
Yes |
Products being ordered |
status |
string |
System |
Current order status |
createdDate |
datetime |
System |
When the order was placed |
orderedBy |
string |
System |
Who placed the order |
Line Item Fields
| Field |
Type |
Required |
Description |
id |
UUID |
System |
Line item unique identifier |
productId |
UUID |
Yes |
Product being ordered |
quantity |
integer |
Yes |
Number of licenses |
billingTerm |
string |
Yes |
Billing term (Monthly, Annual) |
provisionStartDate |
date |
No |
When subscription starts |
lineItemNumber |
integer |
System |
Position in the order |
Common Workflows
Track Order Provisioning Status
- Call
pax8-get-order-by-uuid with the order's uuid
- Check the
status field for the current state
- Review each line item for product details and quantities
- If status is not
Completed, check back periodically
View Order History for a Client
- Find the company UUID using
pax8-list-companies with company_name
- Call
pax8-list-orders with companyId and size=200
- Paginate if needed to get all orders
- Review order dates, statuses, and line items
Verify Order Created Subscriptions
- After an order shows
Completed status, call pax8-list-subscriptions with companyId
- Look for subscriptions matching the ordered product IDs
- Verify quantities and billing terms match the original order
Standard MSP Onboarding Order Verification
When onboarding a new client, verify the typical stack was ordered:
- Call
pax8-list-orders with the companyId
- Check that orders exist for the expected products (M365, security, backup)
- Verify each order reached
Completed status
- Cross-reference with
pax8-list-subscriptions to confirm active subscriptions
Response Examples
Order:
{
"id": "o1r2d3e4-r5s6-7890-abcd-ef1234567890",
"companyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "Completed",
"createdDate": "2026-02-20T09:15:00.000Z",
"orderedBy": "partner@msp.com",
"lineItems": [
{
"id": "l1i2n3e4-i5t6-7890-abcd-ef1234567890",
"productId": "f9e8d7c6-b5a4-3210-fedc-ba0987654321",
"quantity": 25,
"billingTerm": "Annual",
"provisionStartDate": "2026-03-01",
"lineItemNumber": 1
}
]
}
Error Handling
Common Errors
| Error |
Cause |
Resolution |
| Order not found |
Invalid UUID |
Verify the order UUID with pax8-list-orders |
| No orders found |
Company has no orders |
Verify the company UUID is correct |
Order State Issues
| State |
Meaning |
Action |
Failed |
Provisioning failed |
Check the Pax8 portal for details; may need to resubmit |
PendingApproval |
Awaiting approval |
Approve in the Pax8 portal if orderApprovalRequired is set |
Cancelled |
Order was cancelled |
Create a new order if still needed |
Billing Term Reference
| Term |
Commitment |
Seat Changes |
Discount |
| Monthly |
None |
Increase/decrease anytime |
Standard price |
| Annual |
12 months |
Increase anytime, decrease restricted |
~10% discount |
| Triennial |
36 months |
Increase anytime, decrease restricted |
~15% discount |
Best Practices
- Validate before ordering - Check company, product, and quantity before submitting orders in the Pax8 portal
- Use annual billing - Annual commitments save money; recommend to clients
- Bundle line items - Include all products in a single order when possible
- Track provisioning - Monitor order status until completion using
pax8-get-order-by-uuid
- Check product availability - Use
pax8-get-product-by-uuid to verify products are active before ordering
- Handle failures gracefully - Failed orders may need to be resubmitted
- Respect quantity limits - Stay within product min/max quantity bounds
- Document orders - Record order IDs in your PSA for cross-reference
- Test with small quantities - For new products, test with minimal seats before scaling up
- Verify subscriptions - After order completion, confirm subscriptions are active with
pax8-list-subscriptions
Related Skills
1---2name: pax8-orders3description: Pax8 orders: order retrieval, order line items, provisioning status and timelines, billing terms, and the order-to-subscription workflow.4---56# Pax8 Order Management78## Overview910Orders in Pax8 are the mechanism for provisioning new cloud subscriptions for client companies. When an MSP needs to set up a new product for a client -- whether it is Microsoft 365 licenses, a security tool, or backup solution -- they create an order. The order contains one or more line items, each specifying a product, quantity, and billing term. Once submitted, the order is processed and, upon successful provisioning, creates one or more subscriptions.1112## Anti-triggers1314- **What the client currently has** — an order is a historical purchase15 event; the live licence state is `pax8-subscriptions`. An order that16 provisioned twelve months ago tells you nothing about today's seat17 count.18- **What the MSP owes for it** — orders do not carry the charge; use19 `pax8-invoices`.20- **A quote to the client** — a Pax8 order is the MSP buying from the21 distributor, not the client buying from the MSP. Client-facing quoting22 lives in `connectwise-cpq-quotes` or `autotask-quotes`.23- **A purchase order in the accounting system** — use24 `qbo-expenses` or `xero-invoices`; a Pax8 order is not a PO on25 the books.2627## MCP Tools2829### Available Tools3031| Tool | Description | Key Parameters |32|------|-------------|----------------|33| `pax8-list-orders` | List orders with optional filters | `page`, `size`, `companyId` |34| `pax8-get-order-by-uuid` | Get a single order's details | `uuid` (required) |3536### List Orders3738Call `pax8-list-orders` with optional parameters:3940- **Filter by company:** Set `companyId` to a company UUID41- **Paginate:** Set `page` (0-based) and `size` (up to 200)4243**Example: List all orders for a company:**44- `pax8-list-orders` with `companyId=a1b2c3d4-...`, `size=200`4546**Example: List recent orders (first page):**47- `pax8-list-orders` with `page=0`, `size=50`4849### Get a Single Order5051Call `pax8-get-order-by-uuid` with the `uuid` parameter.5253**Example:**54- `pax8-get-order-by-uuid` with `uuid=o1r2d3e4-r5s6-7890-abcd-ef1234567890`5556## Key Concepts5758### Order Lifecycle5960```61Create Order --> Processing --> Provisioning --> Completed --> Subscription Created62 |63 PendingManual64 (vendor action needed)65```6667### Order States6869| State | Description |70|-------|-------------|71| `Submitted` | Order received and being processed |72| `Processing` | Order is being provisioned |73| `Completed` | Order fulfilled; subscriptions created |74| `Failed` | Order could not be provisioned |75| `PendingApproval` | Awaiting MSP approval (self-service orders) |76| `Cancelled` | Order was cancelled before completion |7778### Line Items7980Each order contains one or more line items. Each line item corresponds to a single product:8182| Concept | Description |83|---------|-------------|84| Product | The cloud software being ordered |85| Quantity | Number of seats/licenses |86| Billing Term | Monthly, Annual, or Triennial |87| Provision Start Date | When the subscription should begin |8889### Order-to-Subscription Flow90911. **MSP creates an order** with line items for one or more products922. **Pax8 processes the order** and initiates provisioning with the vendor933. **Provisioning completes** (automated: seconds/minutes; manual: hours/days)944. **Subscription is created** and becomes Active955. **Billing begins** on the provision start date9697## Field Reference9899### Order Fields100101| Field | Type | Required | Description |102|-------|------|----------|-------------|103| `id` | UUID | System | Order unique identifier |104| `companyId` | UUID | Yes | Company the order is for |105| `lineItems` | array | Yes | Products being ordered |106| `status` | string | System | Current order status |107| `createdDate` | datetime | System | When the order was placed |108| `orderedBy` | string | System | Who placed the order |109110### Line Item Fields111112| Field | Type | Required | Description |113|-------|------|----------|-------------|114| `id` | UUID | System | Line item unique identifier |115| `productId` | UUID | Yes | Product being ordered |116| `quantity` | integer | Yes | Number of licenses |117| `billingTerm` | string | Yes | Billing term (Monthly, Annual) |118| `provisionStartDate` | date | No | When subscription starts |119| `lineItemNumber` | integer | System | Position in the order |120121## Common Workflows122123### Track Order Provisioning Status1241251. Call `pax8-get-order-by-uuid` with the order's `uuid`1262. Check the `status` field for the current state1273. Review each line item for product details and quantities1284. If status is not `Completed`, check back periodically129130### View Order History for a Client1311321. Find the company UUID using `pax8-list-companies` with `company_name`1332. Call `pax8-list-orders` with `companyId` and `size=200`1343. Paginate if needed to get all orders1354. Review order dates, statuses, and line items136137### Verify Order Created Subscriptions1381391. After an order shows `Completed` status, call `pax8-list-subscriptions` with `companyId`1402. Look for subscriptions matching the ordered product IDs1413. Verify quantities and billing terms match the original order142143### Standard MSP Onboarding Order Verification144145When onboarding a new client, verify the typical stack was ordered:1461471. Call `pax8-list-orders` with the `companyId`1482. Check that orders exist for the expected products (M365, security, backup)1493. Verify each order reached `Completed` status1504. Cross-reference with `pax8-list-subscriptions` to confirm active subscriptions151152## Response Examples153154**Order:**155156```json157{158 "id": "o1r2d3e4-r5s6-7890-abcd-ef1234567890",159 "companyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",160 "status": "Completed",161 "createdDate": "2026-02-20T09:15:00.000Z",162 "orderedBy": "partner@msp.com",163 "lineItems": [164 {165 "id": "l1i2n3e4-i5t6-7890-abcd-ef1234567890",166 "productId": "f9e8d7c6-b5a4-3210-fedc-ba0987654321",167 "quantity": 25,168 "billingTerm": "Annual",169 "provisionStartDate": "2026-03-01",170 "lineItemNumber": 1171 }172 ]173}174```175176## Error Handling177178### Common Errors179180| Error | Cause | Resolution |181|-------|-------|------------|182| Order not found | Invalid UUID | Verify the order UUID with `pax8-list-orders` |183| No orders found | Company has no orders | Verify the company UUID is correct |184185### Order State Issues186187| State | Meaning | Action |188|-------|---------|--------|189| `Failed` | Provisioning failed | Check the Pax8 portal for details; may need to resubmit |190| `PendingApproval` | Awaiting approval | Approve in the Pax8 portal if `orderApprovalRequired` is set |191| `Cancelled` | Order was cancelled | Create a new order if still needed |192193## Billing Term Reference194195| Term | Commitment | Seat Changes | Discount |196|------|-----------|--------------|----------|197| Monthly | None | Increase/decrease anytime | Standard price |198| Annual | 12 months | Increase anytime, decrease restricted | ~10% discount |199| Triennial | 36 months | Increase anytime, decrease restricted | ~15% discount |200201## Best Practices2022031. **Validate before ordering** - Check company, product, and quantity before submitting orders in the Pax8 portal2042. **Use annual billing** - Annual commitments save money; recommend to clients2053. **Bundle line items** - Include all products in a single order when possible2064. **Track provisioning** - Monitor order status until completion using `pax8-get-order-by-uuid`2075. **Check product availability** - Use `pax8-get-product-by-uuid` to verify products are active before ordering2086. **Handle failures gracefully** - Failed orders may need to be resubmitted2097. **Respect quantity limits** - Stay within product min/max quantity bounds2108. **Document orders** - Record order IDs in your PSA for cross-reference2119. **Test with small quantities** - For new products, test with minimal seats before scaling up21210. **Verify subscriptions** - After order completion, confirm subscriptions are active with `pax8-list-subscriptions`213214## Related Skills215216- [Pax8 API Patterns](../api-patterns/SKILL.md) - MCP tools reference and connection info217- [Pax8 Products](../products/SKILL.md) - Product catalog and pricing218- [Pax8 Subscriptions](../subscriptions/SKILL.md) - Managing resulting subscriptions219- [Pax8 Companies](../companies/SKILL.md) - Company management220- [Pax8 Invoices](../invoices/SKILL.md) - Billing for orders