Skip to main content
Tools Reference

Pax8 Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Pax8 Tools

pax8_ · 86 tools · Free 86 OAuth2 client-credentials; raw JSON passthrough.

All connector tools · Pax8 setup guide

Pax8 tool groups

Companies

ToolPlanAccessSummary
pax8_create_companyFreeWriteCreate a new company (client) on the Pax8 partner tenant.
pax8_get_companyFreeRead-onlyRetrieve a single company by its Pax8 company ID.
pax8_list_companiesFreeRead-onlyList companies (Pax8 clients) on your partner tenant with optional filters.
pax8_update_companyFreeWriteUpdate a company on the Pax8 partner tenant (PATCH).

[Pax8] Create a new company (client) on the Pax8 partner tenant. Pass the full Pax8 create-company body as JSON.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 create-company schema (name, billingAddress, contacts, etc.).

[Pax8] Retrieve a single company by its Pax8 company ID. Prerequisites: call pax8_list_companies to find valid companyId values.

ParamTypeRequiredDefaultDescription
companyIdstringyesThe Pax8 company ID.

[Pax8] List companies (Pax8 clients) on your partner tenant with optional filters. Uses 0-indexed page and size (max 200). Returns the Pax8 paged envelope { content, page }.

ParamTypeRequiredDefaultDescription
billOnBehalfOfEnabledbooleannonullFilter by billOnBehalfOfEnabled flag (true/false).
citystringnonullFilter by city.
countrystringnonullFilter by country.
orderApprovalRequiredbooleannonullFilter by orderApprovalRequired flag (true/false).
pageintegerno0Page number (0-indexed, default 0).
postalCodestringnonullFilter by postal code.
selfServiceAllowedbooleannonullFilter by selfServiceAllowed flag (true/false).
sizeintegerno50Page size (default 50, max 200).
sortstringnonullSort expression, e.g. 'name,asc' or 'country,desc'.
stateOrProvincestringnonullFilter by state or province.
statusstringnonullFilter by status: Active, Inactive, or Deleted.

[Pax8] Update a company on the Pax8 partner tenant (PATCH). Prerequisites: call pax8_get_company first to see current values. Pass only the fields to change.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body with the fields to update (partial update).
companyIdstringyesThe Pax8 company ID to update.

Contacts

ToolPlanAccessSummary
pax8_create_contactFreeWriteCreate a contact on a Pax8 company.
pax8_delete_contactFreeDestructiveDelete a contact from a Pax8 company.
pax8_get_contactFreeRead-onlyRetrieve a single contact under a specific Pax8 company.
pax8_list_contactsFreeRead-onlyList contacts for a specific Pax8 company.
pax8_update_contactFreeDestructiveReplace a contact on a Pax8 company (PUT).

[Pax8] Create a contact on a Pax8 company. Pass the full Pax8 contact body as JSON.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 create-contact schema.
companyIdstringyesThe Pax8 company ID to create the contact under.

[Pax8] Delete a contact from a Pax8 company. Destructive and cannot be undone.

ParamTypeRequiredDefaultDescription
companyIdstringyesThe Pax8 company ID.
contactIdstringyesThe Pax8 contact ID to delete.

[Pax8] Retrieve a single contact under a specific Pax8 company. Prerequisites: call pax8_list_contacts for the company to find valid contactId values.

ParamTypeRequiredDefaultDescription
companyIdstringyesThe Pax8 company ID.
contactIdstringyesThe Pax8 contact ID under that company.

[Pax8] List contacts for a specific Pax8 company. Uses 0-indexed page and size (max 200).

ParamTypeRequiredDefaultDescription
companyIdstringyesThe Pax8 company ID that owns the contacts.
pageintegerno0Page number (0-indexed, default 0).
sizeintegerno50Page size (default 50, max 200).

[Pax8] Replace a contact on a Pax8 company (PUT). Pass the full contact body.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesFull JSON body for the updated contact.
companyIdstringyesThe Pax8 company ID.
contactIdstringyesThe Pax8 contact ID to update.

Invoices

ToolPlanAccessSummary
pax8_get_invoiceFreeRead-onlyRetrieve a single invoice by its Pax8 invoice ID.
pax8_list_draft_invoice_itemsFreeRead-onlyList draft (unbilled) invoice items for the current or next month.
pax8_list_invoice_itemsFreeRead-onlyList line items on a specific Pax8 invoice.
pax8_list_invoicesFreeRead-onlyList partner invoices with optional filters.

[Pax8] Retrieve a single invoice by its Pax8 invoice ID. Prerequisites: call pax8_list_invoices to find valid invoiceId values.

ParamTypeRequiredDefaultDescription
invoiceIdstringyesThe Pax8 invoice ID.

[Pax8] List draft (unbilled) invoice items for the current or next month. Uses 0-indexed page and size (max 200).

ParamTypeRequiredDefaultDescription
companyIdstringnonullFilter draft items to a specific Pax8 company.
monthOffsetintegernonullNumber of months from current: 0 = current month (default), 1 = next month.
pageintegerno0Page number (0-indexed, default 0).
sizeintegerno50Page size (default 50, max 200).

[Pax8] List line items on a specific Pax8 invoice. Uses 0-indexed page and size (max 200).

ParamTypeRequiredDefaultDescription
invoiceIdstringyesThe Pax8 invoice ID.
pageintegerno0Page number (0-indexed, default 0).
sizeintegerno50Page size (default 50, max 200).

[Pax8] List partner invoices with optional filters. Uses 0-indexed page and size (max 200).

ParamTypeRequiredDefaultDescription
balancenumbernonullFilter by exact balance.
carriedBalancenumbernonullFilter by exact carriedBalance.
companyIdstringnonullFilter by Pax8 company ID.
dueDatestringnonullFilter by dueDate (yyyy-MM-dd).
invoiceDatestringnonullFilter by exact invoice date (yyyy-MM-dd).
invoiceDateRangeEndstringnonullFilter by invoice date less-than-or-equal (yyyy-MM-dd).
invoiceDateRangeStartstringnonullFilter by invoice date greater-than-or-equal (yyyy-MM-dd).
pageintegerno0Page number (0-indexed, default 0).
sizeintegerno50Page size (default 50, max 200).
sortstringnonullSort expression, e.g. 'invoiceDate,desc' or 'total,asc'.
statusstringnonullFilter by status: Unpaid, Paid, Void, Carried, 'Nothing Due', or Credited.
totalnumbernonullFilter by exact total.

Orders

ToolPlanAccessSummary
pax8_create_orderFreeDestructiveCreate an order on the partner tenant.
pax8_get_orderFreeRead-onlyRetrieve a single order by its Pax8 order ID.
pax8_list_ordersFreeRead-onlyList orders on the partner tenant with optional company filter.

[Pax8] Create an order on the partner tenant. Prerequisites: call pax8_get_product_dependencies and pax8_get_product_provision_details for each product to build a valid lineItems + provisioningDetails body.

ParamTypeRequiredDefaultDescription
isMockbooleannonullOptional: if true, Pax8 performs validations only and skips persistence (dry run).
orderJsonstringyesFull Pax8 order JSON body (lineItems, provisioningDetails, companyId, billingTerm, etc.).

[Pax8] Retrieve a single order by its Pax8 order ID. Prerequisites: call pax8_list_orders to find valid orderId values.

ParamTypeRequiredDefaultDescription
orderIdstringyesThe Pax8 order ID.

[Pax8] List orders on the partner tenant with optional company filter. Uses 0-indexed page and size (max 200).

ParamTypeRequiredDefaultDescription
companyIdstringnonullFilter orders to a specific Pax8 company ID.
pageintegerno0Page number (0-indexed, default 0).
sizeintegerno50Page size (default 50, max 200).

Products

ToolPlanAccessSummary
pax8_get_productFreeRead-onlyRetrieve a single product from the Pax8 catalog by productId.
pax8_get_product_dependenciesFreeRead-onlyRetrieve the dependency graph for a Pax8 product.
pax8_get_product_pricingFreeRead-onlyRetrieve pricing for a Pax8 product.
pax8_get_product_provision_detailsFreeRead-onlyRetrieve the provisioning details schema for a Pax8 product (required fields and prompts to collect before placing an order).
pax8_list_productsFreeRead-onlyList Pax8 catalog products with optional search and vendor filters.

[Pax8] Retrieve a single product from the Pax8 catalog by productId. Prerequisites: call pax8_list_products to find valid productId values.

ParamTypeRequiredDefaultDescription
productIdstringyesThe Pax8 product ID.

[Pax8] Retrieve the dependency graph for a Pax8 product. Use this before pax8_create_order to learn what prerequisite or bundled products must also be ordered.

ParamTypeRequiredDefaultDescription
productIdstringyesThe Pax8 product ID.

[Pax8] Retrieve pricing for a Pax8 product. Optionally scope to a specific company to surface company-specific pricing.

ParamTypeRequiredDefaultDescription
companyIdstringnonullOptional Pax8 company ID to receive company-specific pricing.
productIdstringyesThe Pax8 product ID.

[Pax8] Retrieve the provisioning details schema for a Pax8 product (required fields and prompts to collect before placing an order). Use this alongside pax8_get_product_dependencies before pax8_create_order.

ParamTypeRequiredDefaultDescription
productIdstringyesThe Pax8 product ID.

[Pax8] List Pax8 catalog products with optional search and vendor filters. Uses 0-indexed page and size (max 200).

ParamTypeRequiredDefaultDescription
pageintegerno0Page number (0-indexed, default 0).
searchstringnonullFree-text search over name, vendor, SKU, and ID.
sizeintegerno50Page size (default 50, max 200).
sortstringnonullSort expression, e.g. 'name,asc' or 'vendor,desc'.
vendorNamestringnonullFilter by vendor name (e.g. 'Microsoft').

Subscriptions

ToolPlanAccessSummary
pax8_cancel_subscriptionFreeDestructiveCancel a subscription.
pax8_get_subscriptionFreeRead-onlyRetrieve a single subscription by its Pax8 subscription ID.
pax8_get_subscription_historyFreeRead-onlyRetrieve the history (state transitions and quantity changes) for a specific subscription.
pax8_list_subscriptionsFreeRead-onlyList subscriptions on the partner tenant with optional filters.
pax8_update_subscriptionFreeDestructiveUpdate a subscription (PUT).

[Pax8] Cancel a subscription. Pax8 may schedule the cancellation for a specific date. Destructive — may trigger vendor-side deprovisioning.

ParamTypeRequiredDefaultDescription
cancelDatestringnonullOptional future date (yyyy-MM-dd) to schedule the cancellation. Omit to cancel immediately per Pax8 policy.
subscriptionIdstringyesThe Pax8 subscription ID to cancel.

[Pax8] Retrieve a single subscription by its Pax8 subscription ID. Prerequisites: call pax8_list_subscriptions to find valid subscriptionId values.

ParamTypeRequiredDefaultDescription
subscriptionIdstringyesThe Pax8 subscription ID.
ParamTypeRequiredDefaultDescription
subscriptionIdstringyesThe Pax8 subscription ID.

[Pax8] List subscriptions on the partner tenant with optional filters. Uses 0-indexed page and size (max 200).

ParamTypeRequiredDefaultDescription
billingTermstringnonullFilter by billingTerm: Monthly, Annual, 2-Year, 3-Year, One-Time, Trial, or Activation.
companyIdstringnonullFilter by Pax8 company ID.
pageintegerno0Page number (0-indexed, default 0).
productIdstringnonullFilter by Pax8 product ID.
sizeintegerno50Page size (default 50, max 200).
sortstringnonullSort expression, e.g. 'startDate,desc' or 'price,asc'.
statusstringnonullFilter by status: Active, Cancelled, PendingManual, PendingAutomated, PendingCancel, WaitingForDetails, Trial, Converted, PendingActivation, or Activated.

[Pax8] Update a subscription (PUT). Prerequisites: call pax8_get_subscription to see current state before applying changes.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesFull subscription JSON body with the updated fields.
subscriptionIdstringyesThe Pax8 subscription ID to update.

Usage Summaries

ToolPlanAccessSummary
pax8_get_usage_summaryFreeRead-onlyRetrieve a single usage summary by ID.
pax8_list_subscription_usage_summariesFreeRead-onlyList usage summaries for a specific subscription.
pax8_list_usage_summary_linesFreeRead-onlyList usage lines under a specific usage summary, optionally filtered by date and product.
ParamTypeRequiredDefaultDescription
usageSummaryIdstringyesThe Pax8 usage summary ID.

[Pax8] List usage summaries for a specific subscription. Uses 0-indexed page and size (max 200).

ParamTypeRequiredDefaultDescription
companyIdstringnonullFilter by Pax8 company ID.
pageintegerno0Page number (0-indexed, default 0).
resourceGroupstringnonullFilter by resource group.
sizeintegerno50Page size (default 50, max 200).
sortstringnonullSort expression, e.g. 'currentCharges,desc' or 'partnerTotal,asc'.
subscriptionIdstringyesThe Pax8 subscription ID.
ParamTypeRequiredDefaultDescription
productIdstringnonullFilter to a specific Pax8 product ID.
usageDatestringnonullFilter to usage recorded on this date (yyyy-MM-dd).
usageSummaryIdstringyesThe Pax8 usage summary ID.

Quotes

ToolPlanAccessSummary
pax8_create_quoteFreeWriteCreate a quote.
pax8_delete_quoteFreeDestructiveDelete a quote permanently.
pax8_get_quoteFreeRead-onlyRetrieve a single quote by its Pax8 quote ID.
pax8_list_quotesFreeRead-onlyList quotes on the partner tenant with optional filters.
pax8_take_quote_ownershipFreeDestructiveTake ownership of a quote (e.g. to edit another user's draft).
pax8_update_quoteFreeDestructiveUpdate an existing quote (PUT).

[Pax8] Create a quote. Prerequisites: call pax8_list_companies to find a valid clientId.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesFull JSON body matching the Pax8 create-quote schema (client, sections, lineItems, etc.).

[Pax8] Delete a quote permanently. Destructive and cannot be undone.

ParamTypeRequiredDefaultDescription
quoteIdstringyesThe Pax8 quote ID to delete.

[Pax8] Retrieve a single quote by its Pax8 quote ID. Prerequisites: call pax8_list_quotes to find valid quoteId values.

ParamTypeRequiredDefaultDescription
quoteIdstringyesThe Pax8 quote ID.

[Pax8] List quotes on the partner tenant with optional filters. IMPORTANT: the quoting API uses 'limit' (not 'size') for page size; the parameter here is still called limit to match.

ParamTypeRequiredDefaultDescription
accountstringnonullFilter by account scope: user or partner.
intentTypestringnonullFilter by intent type: PARTNER_TO_CLIENT, PAX8_TO_PARTNER, or PAX8_TO_PARTNER_CLIENT.
limitintegerno50Page size - the quoting surface calls this 'limit' (default 50, max 200).
pageintegerno0Page number (0-indexed, default 0).
partnerIdstringnonullFilter by Pax8 partner ID.
searchstringnonullFree-text search over client name, reference code, creator, and invoice data.
sortstringnonullSort expression, e.g. 'status,desc' or 'totals.initialTotal,asc'.
statusstringnonullComma-separated statuses: draft, assigned, sent, closed, declined, accepted, changes_requested, expired, pending.

[Pax8] Take ownership of a quote (e.g. to edit another user's draft). The calling user becomes the quote owner.

ParamTypeRequiredDefaultDescription
quoteIdstringyesThe Pax8 quote ID to take ownership of.

[Pax8] Update an existing quote (PUT). Pass the full updated quote body.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesFull JSON body for the updated quote.
quoteIdstringyesThe Pax8 quote ID to update.

Quote Line Items

ToolPlanAccessSummary
pax8_add_quote_line_itemsFreeWriteAdd one or more line items to a quote.
pax8_bulk_delete_quote_line_itemsFreeDestructiveBulk-delete multiple line items from a quote.
pax8_delete_quote_line_itemFreeDestructiveDelete a single line item from a quote by ID.
pax8_update_quote_line_itemsFreeDestructiveUpdate one or more existing line items on a quote (PUT).

[Pax8] Add one or more line items to a quote. Prerequisites: call pax8_list_quotes to get quoteId, and pax8_list_products if adding standard line items.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON array (or envelope) of line items matching the Pax8 add-line-items schema.
quoteIdstringyesThe Pax8 quote ID.

[Pax8] Bulk-delete multiple line items from a quote. Destructive. Pass a JSON body containing the array of lineItemIds to remove.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body listing the lineItemIds to delete, e.g. {"lineItemIds":["...","..."]}.
quoteIdstringyesThe Pax8 quote ID.

[Pax8] Delete a single line item from a quote by ID. Destructive.

ParamTypeRequiredDefaultDescription
lineItemIdstringyesThe Pax8 line item ID to remove.
quoteIdstringyesThe Pax8 quote ID.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 update-line-items schema.
quoteIdstringyesThe Pax8 quote ID.

Quote Sections

ToolPlanAccessSummary
pax8_create_quote_sectionFreeWriteCreate a new section on a quote.
pax8_list_quote_sectionsFreeRead-onlyList the sections (groups of line items) on a specific quote.
pax8_update_quote_sectionsFreeDestructiveUpdate one or more sections on a quote (PUT).

[Pax8] Create a new section on a quote. Pass the full Pax8 section body.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 create-section schema.
quoteIdstringyesThe Pax8 quote ID.
ParamTypeRequiredDefaultDescription
quoteIdstringyesThe Pax8 quote ID.

[Pax8] Update one or more sections on a quote (PUT). Pass an array of section bodies as a JSON envelope.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 update-sections schema.
quoteIdstringyesThe Pax8 quote ID.

Quote Attachments

ToolPlanAccessSummary
pax8_copy_library_attachment_to_quoteFreeWriteCopy one or more attachments from the partner's shared quote-attachment library onto a specific quote.
pax8_delete_quote_attachmentFreeDestructiveDelete a single attachment from a quote.
pax8_download_all_quote_attachmentsFreeRead-onlyDownload all attachments for a quote as a single ZIP.
pax8_get_quote_attachmentFreeRead-onlyRetrieve attachment metadata for a specific quote attachment.
pax8_update_quote_attachmentsFreeDestructiveUpdate metadata on one or more quote attachments (PUT).
pax8_upload_quote_attachmentFreeWriteUpload an attachment to a quote.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body with the library attachmentIds to copy, matching the Pax8 copy-from-library schema.
quoteIdstringyesThe Pax8 quote ID.

[Pax8] Delete a single attachment from a quote. Destructive and cannot be undone.

ParamTypeRequiredDefaultDescription
attachmentIdstringyesThe Pax8 attachment ID to delete.
quoteIdstringyesThe Pax8 quote ID.

[Pax8] Download all attachments for a quote as a single ZIP. Pax8 returns application/zip bytes; StackJack wraps them in a JSON envelope { contentType, fileName, base64 }. Agents should base64-decode the `base64` field to reconstruct the ZIP file.

ParamTypeRequiredDefaultDescription
quoteIdstringyesThe Pax8 quote ID.

[Pax8] Retrieve attachment metadata for a specific quote attachment. Does not stream the binary file itself.

ParamTypeRequiredDefaultDescription
attachmentIdstringyesThe Pax8 attachment ID.
quoteIdstringyesThe Pax8 quote ID.

[Pax8] Update metadata on one or more quote attachments (PUT). Pass the Pax8 update-attachments envelope as JSON.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 update-attachments schema.
quoteIdstringyesThe Pax8 quote ID.

[Pax8] Upload an attachment to a quote. File content must be base64-encoded (MCP has no binary channel). Keep uploads small (<5MB). To edit attachment metadata after upload, use pax8_update_quote_attachments.

ParamTypeRequiredDefaultDescription
contentTypestringyesFile MIME content type, e.g. 'application/pdf'.
fileBase64stringyesBase64-encoded file bytes.
fileNamestringyesOriginal file name, e.g. 'proposal.pdf'.
quoteIdstringyesThe Pax8 quote ID.

Quote Access List

ToolPlanAccessSummary
pax8_add_quote_access_list_entryFreeDestructiveAdd one or more entries to a quote's access list (e.g. grant a client user access to view the quote).
pax8_delete_quote_access_list_entryFreeDestructiveRemove a specific access-list entry from a quote, revoking that user's access.
pax8_list_quote_access_listFreeRead-onlyList the access-list entries (users / emails that can view or edit a shared quote) for a specific quote.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 add-access-list-entry schema.
quoteIdstringyesThe Pax8 quote ID.
ParamTypeRequiredDefaultDescription
accessListEntryIdstringyesThe access-list entry ID to delete.
quoteIdstringyesThe Pax8 quote ID.
ParamTypeRequiredDefaultDescription
quoteIdstringyesThe Pax8 quote ID.

Quote Preferences

ToolPlanAccessSummary
pax8_delete_preference_attachmentFreeDestructiveDelete a preference attachment by its Pax8 attachment ID.
pax8_get_quote_preferencesFreeRead-onlyRetrieve the partner's quote-preference defaults (branding, default terms, etc.) used when rendering new quotes.
pax8_update_quote_preferencesFreeDestructiveUpdate the partner's quote-preference defaults (PUT).
pax8_upload_preference_attachmentFreeWriteAssociate one or more existing library attachments with the partner's quote preferences.

[Pax8] Delete a preference attachment by its Pax8 attachment ID. Destructive.

ParamTypeRequiredDefaultDescription
attachmentIdstringyesThe Pax8 preference attachment ID.

[Pax8] Update the partner's quote-preference defaults (PUT). Pass the full Pax8 preferences body.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 persist-quote-preferences schema.

[Pax8] Associate one or more existing library attachments with the partner's quote preferences. Pass a JSON body matching the Pax8 AddPreferenceAttachmentsPayload schema: {"attachments":["<library-attachment-uuid>", ...]}. Upload the file to the library first via pax8_upload_library_attachment.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 AddPreferenceAttachmentsPayload schema: {"attachments":["<uuid>", ...]}.

Library Attachments

ToolPlanAccessSummary
pax8_copy_quote_attachment_to_libraryFreeWriteCopy one or more attachments from a specific quote into the partner's shared library for reuse on future quotes.
pax8_delete_library_attachmentFreeDestructiveDelete a library attachment permanently.
pax8_get_library_attachmentFreeRead-onlyRetrieve metadata for a specific library attachment.
pax8_list_library_attachmentsFreeRead-onlyList attachments in the partner's shared quote-attachment library.
pax8_replace_library_attachmentFreeDestructiveReplace a library attachment's binary via PATCH multipart upload.
pax8_update_library_attachmentsFreeDestructiveUpdate metadata on one or more library attachments (PUT).
pax8_upload_library_attachmentFreeWriteUpload a new attachment into the partner's shared quote-attachment library.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 add-quote-attachments-to-library schema (source quoteId + attachmentIds).

[Pax8] Delete a library attachment permanently. Destructive and cannot be undone.

ParamTypeRequiredDefaultDescription
attachmentIdstringyesThe Pax8 library attachment ID to delete.

[Pax8] Retrieve metadata for a specific library attachment. Does not stream binary content.

ParamTypeRequiredDefaultDescription
attachmentIdstringyesThe Pax8 library attachment ID.

[Pax8] Replace a library attachment's binary via PATCH multipart upload. File content must be base64-encoded (MCP has no binary channel). Intended for small files (<5MB).

ParamTypeRequiredDefaultDescription
attachmentIdstringyesThe Pax8 library attachment ID.
contentTypestringyesFile MIME content type.
fileBase64stringyesBase64-encoded file bytes.
fileNamestringyesOriginal file name.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 update-library-attachments schema.

[Pax8] Upload a new attachment into the partner's shared quote-attachment library. File content must be base64-encoded (MCP has no binary channel). Keep uploads small (<5MB). To edit metadata after upload, use pax8_update_library_attachments.

ParamTypeRequiredDefaultDescription
contentTypestringyesFile MIME content type.
fileBase64stringyesBase64-encoded file bytes.
fileNamestringyesOriginal file name.

Vendor Provisioning

ToolPlanAccessSummary
pax8_vendor_create_order_event_simulationFreeDestructiveSimulate an order event against your vendor integration.
pax8_vendor_create_provision_attemptFreeDestructiveCreate a new provision attempt for a provision request and provision detail (your vendor integration signaling that it has begun work).
pax8_vendor_create_provision_resultFreeDestructiveReport a provision result back to Pax8 (success, failure, or in-progress) for a provision request.
pax8_vendor_create_provisioner_webhookFreeWriteCreate a new webhook configuration for a provisioner (Pax8 delivers provision events to this endpoint).
pax8_vendor_get_latest_provision_attemptFreeRead-onlyRetrieve the most recent provision attempt for a provision request (shortcut so you don't have to list+sort).
pax8_vendor_get_latest_provision_detailFreeRead-onlyRetrieve the most recent provision detail record for a provision request.
pax8_vendor_get_latest_provision_resultFreeRead-onlyRetrieve the most recent provision result for a provision request.
pax8_vendor_get_latest_provisioner_webhookFreeRead-onlyRetrieve the most recent webhook configuration for a provisioner.
pax8_vendor_get_provision_attemptFreeRead-onlyRetrieve a single provision attempt by its ID under a provision request.
pax8_vendor_get_provision_detailFreeRead-onlyRetrieve a specific provision detail by ID under a provision request.
pax8_vendor_get_provision_requestFreeRead-onlyRetrieve a single provision request by its ID.
pax8_vendor_get_provision_resultFreeRead-onlyRetrieve a single provision result by ID under a provision request.
pax8_vendor_get_provisionerFreeRead-onlyRetrieve a single provisioner by ID.
pax8_vendor_get_provisioner_webhookFreeRead-onlyRetrieve a single webhook configuration for a provisioner.
pax8_vendor_list_provision_attemptsFreeRead-onlyList all provision attempts for a specific provision request, optionally scoped to a provision detail.
pax8_vendor_list_provision_detailsFreeRead-onlyList all provision details (per-subscription provisioning state records) for a provision request.
pax8_vendor_list_provision_requestsFreeRead-onlyList all provision requests Pax8 has sent to your vendor integration.
pax8_vendor_list_provision_resultsFreeRead-onlyList all provision results (terminal outcomes reported back to Pax8) for a provision request, optionally scoped to a specific provision attempt.
pax8_vendor_list_provisioner_webhooksFreeRead-onlyList all webhook configurations for a specific provisioner.
pax8_vendor_list_provisionersFreeRead-onlyList all provisioners registered for your vendor integration.
pax8_vendor_list_unfulfilled_provision_requestsFreeRead-onlyList only provision requests that are not yet fulfilled by your vendor integration (work queue).

[Pax8] Simulate an order event against your vendor integration. Used during vendor integration development / testing to trigger the downstream provisioning pipeline without a real order. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 create-order-event-simulation schema.

[Pax8] Create a new provision attempt for a provision request and provision detail (your vendor integration signaling that it has begun work). Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 create-provision-attempt schema.
provisionRequestIdstringyesThe Pax8 provision request ID.

[Pax8] Report a provision result back to Pax8 (success, failure, or in-progress) for a provision request. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 create-provision-result schema.
provisionRequestIdstringyesThe Pax8 provision request ID.

[Pax8] Create a new webhook configuration for a provisioner (Pax8 delivers provision events to this endpoint). Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body matching the Pax8 create-webhook schema.
provisionerIdstringyesThe Pax8 provisioner ID.

[Pax8] Retrieve the most recent provision attempt for a provision request (shortcut so you don't have to list+sort). Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionRequestIdstringyesThe Pax8 provision request ID.

[Pax8] Retrieve the most recent provision detail record for a provision request. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionRequestIdstringyesThe Pax8 provision request ID.

[Pax8] Retrieve the most recent provision result for a provision request. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionRequestIdstringyesThe Pax8 provision request ID.

[Pax8] Retrieve the most recent webhook configuration for a provisioner. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionerIdstringyesThe Pax8 provisioner ID.

[Pax8] Retrieve a single provision attempt by its ID under a provision request. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionAttemptIdstringyesThe Pax8 provision attempt ID.
provisionRequestIdstringyesThe Pax8 provision request ID.

[Pax8] Retrieve a specific provision detail by ID under a provision request. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionDetailIdstringyesThe Pax8 provision detail ID.
provisionRequestIdstringyesThe Pax8 provision request ID.

[Pax8] Retrieve a single provision request by its ID. Prerequisites: call pax8_vendor_list_provision_requests for valid IDs. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionRequestIdstringyesThe Pax8 provision request ID.

[Pax8] Retrieve a single provision result by ID under a provision request. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionRequestIdstringyesThe Pax8 provision request ID.
provisionResultIdstringyesThe Pax8 provision result ID.

[Pax8] Retrieve a single provisioner by ID. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionerIdstringyesThe Pax8 provisioner ID.

[Pax8] Retrieve a single webhook configuration for a provisioner. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionerIdstringyesThe Pax8 provisioner ID.
webhookIdstringyesThe Pax8 webhook ID.

[Pax8] List all provision attempts for a specific provision request, optionally scoped to a provision detail. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionDetailIdstringnonullOptional: filter attempts to a specific provision detail ID.
provisionRequestIdstringyesThe Pax8 provision request ID.

[Pax8] List all provision details (per-subscription provisioning state records) for a provision request. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionRequestIdstringyesThe Pax8 provision request ID.

[Pax8] List all provision requests Pax8 has sent to your vendor integration. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

[Pax8] List all provision results (terminal outcomes reported back to Pax8) for a provision request, optionally scoped to a specific provision attempt. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionAttemptIdstringnonullOptional: filter results to a specific provision attempt ID.
provisionRequestIdstringyesThe Pax8 provision request ID.

[Pax8] List all webhook configurations for a specific provisioner. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
provisionerIdstringyesThe Pax8 provisioner ID.

[Pax8] List all provisioners registered for your vendor integration. Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

[Pax8] List only provision requests that are not yet fulfilled by your vendor integration (work queue). Requires Pax8 credentials with the api://provisioning audience (vendor:provisioning scope). Typical MSP credentials do not have this grant.

Vendor Usage

ToolPlanAccessSummary
pax8_vendor_list_usage_linesFreeRead-onlyList usage lines your vendor integration has reported for a subscription and billing period.
pax8_vendor_save_usage_linesFreeDestructiveSave (append or overwrite) per-day usage lines for a subscription billing period.
pax8_vendor_save_usage_lines_aggregateFreeDestructiveSave usage lines with an aggregate partner quantity (single total instead of per-day entries) for a subscription billing period.

[Pax8] List usage lines your vendor integration has reported for a subscription and billing period. Requires Pax8 credentials with the api://usage audience (read:usageLine or write:usageLine scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
billingPeriodstringnonullBilling period in yyyy-MM format (e.g. 2026-04).
externalSubscriptionIdstringnonullExternal (vendor-side) subscription ID alternative to subscriptionId.
subscriptionIdstringnonullPax8 subscription ID to scope usage lines.
summaryKeystringnonullSummary key filter.

[Pax8] Save (append or overwrite) per-day usage lines for a subscription billing period. Control append vs overwrite with overwriteSameDayUsage. Requires Pax8 credentials with the api://usage audience (read:usageLine or write:usageLine scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
billingPeriodstringnonullBilling period in yyyy-MM format.
bodyJsonstringyesJSON body matching the Pax8 save-usage-lines schema (array of usage lines).
externalSubscriptionIdstringnonullExternal (vendor-side) subscription ID alternative to subscriptionId.
overwriteSameDayUsagebooleannonullIf false, usage lines for the same summary key are appended instead of overwritten.
subscriptionIdstringnonullPax8 subscription ID to scope the save.

[Pax8] Save usage lines with an aggregate partner quantity (single total instead of per-day entries) for a subscription billing period. Requires Pax8 credentials with the api://usage audience (read:usageLine or write:usageLine scope). Typical MSP credentials do not have this grant.

ParamTypeRequiredDefaultDescription
billingPeriodstringnonullBilling period in yyyy-MM format.
bodyJsonstringyesJSON body matching the Pax8 save-aggregate-usage-lines schema.
externalSubscriptionIdstringnonullExternal (vendor-side) subscription ID alternative to subscriptionId.
overwriteSameDayUsagebooleannonullIf false, usage lines for the same summary key are appended instead of overwritten.
subscriptionIdstringnonullPax8 subscription ID.