Pax8

App · 25 actions

Run your Pax8 cloud marketplace: manage customer companies and contacts, look up products and pricing, place orders, change or cancel subscriptions, and read invoices and usage.

Actions

ActionWhat it does
Cancel subscriptionCancel a subscription now or on a date.
Create companyAdd a customer company.
Create contactAdd a contact to a company, optionally as its primary admin, billing or technical contact.
Delete contactRemove a contact from a company.
Get companyGet one customer company with its address, phone, website, billing settings and status.
Get orderGet one order with who placed it and each line item's product, quantity, term and subscription.
Get productGet one product with its description, vendor, SKUs and whether it needs a commitment.
Get product dependenciesGet the commitment terms a product can be ordered on and the products it requires.
Get product pricingGet what a product costs you and its suggested price, for each billing term and quantity range, optionally for one company.
Get product provisioning detailsGet the questions an order for a product must answer, such as a Microsoft domain, with the choices each allows.
Get subscriptionGet a subscription as it is now: product, quantity, price, cost, term, commitment and status.
Get subscription historyGet every change made to a subscription (quantity, term, price or product), most recent first.
List companiesList your customer companies, filtered by status, place or billing settings.
List contactsList a company's contacts, newest first, with the kinds they are primary contact for.
List invoice itemsList the line items of an invoice: each company, product, quantity, period, price and cost.
List invoicesList Pax8's invoices to you with their totals, balances and status, filtered by status, date or company.
List ordersList orders, for every company or one.
List productsSearch the products you can sell in Pax8's catalogue by name, SKU or vendor.
List subscriptionsList subscriptions with their product, quantity, price and status, filtered by company, product, status or term.
List usage linesList the usage recorded on one day under a usage summary: each product, quantity, charge and profit.
List usage summariesList this month's usage charges for a usage-billed subscription, such as Azure, one summary per resource group.
Place orderBuy a product for a company.
Update companyChange a company's name, address, phone, website, reference or billing settings.
Update contactChange a contact's name, email, phone or what they are primary contact for.
Update subscriptionChange a subscription's quantity, price, billing term or start.

Cancel subscription

Cancel a subscription now or on a date. A commitment may not allow it, or may charge a fee.

Inputs

Subscriptionsubscription_idtextRequired
The subscription. Pick one, or give its id from an earlier step.
Cancel oncancel_datedate
The day to cancel it. Leave empty to cancel now.

Outputs

cancel_datetext
The day asked for (YYYY-MM-DD), empty for now
cancelledtrue/false
Always true once Pax8 accepts it
subscription_idtext
The subscription cancelled
Example output
{
  "cancel_date": "",
  "cancelled": true,
  "subscription_id": "05c587df-9e7d-4ef9-8218-0262198e36c9"
}

Create company

Add a customer company. Give a primary contact to make it active at once; without one it stays inactive until contacts are added.

Inputs

Company namenametextRequired
The customer company's name.
StreetstreettextRequired
The street address.
CitycitytextRequired
The city.
Postal codepostal_codetextRequired
The postal or ZIP code.
CountrycountrytextRequired
The country of the address.One of: AF (Afghanistan), AX (Åland Islands), AL (Albania), DZ (Algeria), AD (Andorra), AO (Angola), AI (Anguilla), AQ (Antarctica), AG (Antigua & Barbuda), AR (Argentina), and 239 more.
PhonephonetextRequired
The company's main phone number, such as 303-555-0100.
WebsitewebsitetextRequired
The company's website, such as https://acme-dental.com.
Street, line 2street2text
A suite, floor or unit.
State or provincestate_or_provincetext
The state or province, such as CO.
External IDexternal_idtext
Your own reference for the company, such as its id in your PSA.
Pax8 bills the companybill_on_behalf_of_enabledtext
Yes if Pax8 bills the company directly on your behalf; no if you bill it.One of: true (Yes), false (No).
Self-serviceself_service_allowedtext
Whether the company can order for itself in Pax8.One of: true (Yes), false (No).
Orders need approvalorder_approval_requiredtext
Whether the company's own orders wait for your approval.One of: true (Yes), false (No).
Primary contact first namecontact_first_nametext
To make the company active straight away, give a primary contact: their first name here, and their last name, email and phone.
Primary contact last namecontact_last_nametext
Their last name.
Primary contact emailcontact_emailtext
Their email address.
Primary contact phonecontact_phonetext
Their phone number.

Outputs

companyobject
The company
Example output
{
  "company": {
    "address": {
      "city": "Denver",
      "country": "US",
      "postalCode": "80210",
      "stateOrProvince": "Colorado",
      "street": "48918 Liberty Lane Ave",
      "street2": ""
    },
    "billOnBehalfOfEnabled": false,
    "externalId": "A123",
    "id": "a4dfc6bf-f02e-4a79-9844-66ba6c02ec3a",
    "name": "VFC Network, Inc",
    "orderApprovalRequired": false,
    "phone": "123-456-5555",
    "phoneCountryCallingCode": "",
    "phoneCountryCode": "",
    "phoneNumber": "",
    "selfServiceAllowed": false,
    "status": "Active",
    "updatedDate": "2023-08-11T11:33:12.314-0600",
    "website": "vfc-network-inc-liberty.com"
  }
}

Create contact

Add a contact to a company, optionally as its primary admin, billing or technical contact.

Inputs

Companycompany_idtextRequired
The customer company. Pick one, or give its id from an earlier step.
First namefirst_nametextRequired
The contact's first name.
Last namelast_nametextRequired
The contact's last name.
EmailemailtextRequired
The contact's email address.
PhonephonetextRequired
The contact's phone number, such as 303-555-0100.
Primary contact forprimary_forlist
Make this person the company's primary contact for these. A company needs one primary contact of each kind to be active.One or more of: Admin, Billing, Technical.

Outputs

company_idtext
The company the contact is in
contactobject
The contact
Example output
{
  "company_id": "a4dfc6bf-f02e-4a79-9844-66ba6c02ec3a",
  "contact": {
    "createdDate": "2020-05-12",
    "email": "john.doe@vfc-network-inc-liberty.com",
    "firstName": "John",
    "id": "18d6329e-93f9-46a5-9df7-37e4c29d2840",
    "lastName": "Doe",
    "phone": "555-555-5555",
    "types": [
      {
        "primary": true,
        "type": "Admin"
      },
      {
        "primary": true,
        "type": "Billing"
      },
      {
        "primary": true,
        "type": "Technical"
      }
    ]
  }
}

Delete contact

Remove a contact from a company.

Inputs

Companycompany_idtextRequired
The customer company. Pick one, or give its id from an earlier step.
Contactcontact_idtextRequired
The contact. Pick one, or give its id from an earlier step.

Outputs

company_idtext
The company
contact_idtext
The contact deleted
deletedtrue/false
Always true once deleted
Example output
{
  "company_id": "a4dfc6bf-f02e-4a79-9844-66ba6c02ec3a",
  "contact_id": "18d6329e-93f9-46a5-9df7-37e4c29d2840",
  "deleted": true
}

Get company

Get one customer company with its address, phone, website, billing settings and status.

Inputs

Companycompany_idtextRequired
The customer company. Pick one, or give its id from an earlier step.

Outputs

companyobject
The company
Example output
{
  "company": {
    "address": {
      "city": "Denver",
      "country": "US",
      "postalCode": "80210",
      "stateOrProvince": "Colorado",
      "street": "48918 Liberty Lane Ave",
      "street2": ""
    },
    "billOnBehalfOfEnabled": false,
    "externalId": "A123",
    "id": "a4dfc6bf-f02e-4a79-9844-66ba6c02ec3a",
    "name": "VFC Network, Inc",
    "orderApprovalRequired": false,
    "phone": "123-456-5555",
    "phoneCountryCallingCode": "",
    "phoneCountryCode": "",
    "phoneNumber": "",
    "selfServiceAllowed": false,
    "status": "Active",
    "updatedDate": "2023-08-11T11:33:12.314-0600",
    "website": "vfc-network-inc-liberty.com"
  }
}

Get order

Get one order with who placed it and each line item's product, quantity, term and subscription.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders' or an earlier step.

Outputs

orderobject
The order
Example output
{
  "order": {
    "companyId": "fe7a2d5f-4a14-43ff-940e-a65cda66474a",
    "createdDate": "2020-12-01",
    "id": "8e42de97-6bfe-4db5-864b-d2e4b18c71e2",
    "isScheduled": false,
    "lineItems": [
      {
        "billingTerm": "Monthly",
        "commitmentTermId": "",
        "id": "4915142b-1b3f-4488-9e68-e979dc661130",
        "lineItemNumber": 1,
        "parentLineItemNumber": 0,
        "parentSubscriptionId": "",
        "productId": "e91bba5e-a9a3-483f-b036-f80165d410e3",
        "provisionStartDate": "2021-01-01T08:30:00Z",
        "provisioningDetails": [],
        "quantity": 5,
        "subscriptionId": "efcf8cb8-63fc-4dc4-8caa-6d6810ee8a97"
      }
    ],
    "orderedBy": "",
    "orderedByUserEmail": "",
    "orderedByUserId": ""
  }
}

Get product

Get one product with its description, vendor, SKUs and whether it needs a commitment.

Inputs

Productproduct_idtextRequired
The product. Pick one, or give its id from an earlier step.

Outputs

productobject
The product
Example output
{
  "product": {
    "altVendorSku": "",
    "description": "Microsoft 365 E3 is designed for large organizations.",
    "id": "e91bba5e-a9a3-483f-b036-f80165d410e3",
    "name": "Microsoft Office 365 E3",
    "requiresCommitment": false,
    "shortDescription": "Microsoft Office 365 E3 includes fully installed Office applications across multiple devices, email hosting, HD video conferencing, and features to support compliance.",
    "sku": "MST-OFC-EE3-C100",
    "vendorName": "Microsoft",
    "vendorSku": "796B6B5F-613C-4E24-A17C-EBA730D49C02"
  }
}

Get product dependencies

Get the commitment terms a product can be ordered on and the products it requires.

Inputs

Productproduct_idtextRequired
The product. Pick one, or give its id from an earlier step.

Outputs

commitment_dependencieslist
The commitment terms
product_dependencieslist
What the product requires, with the products that satisfy it
product_idtext
The id it was asked about
Example output
{
  "commitment_dependencies": [
    {
      "allowForEarlyCancellation": true,
      "allowForQuantityDecrease": true,
      "allowForQuantityIncrease": true,
      "autoRenew": true,
      "cancellationFeeApplied": true,
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isTransferable": true,
      "renewalWindowDaysAfterTermEnd": 0,
      "renewalWindowDaysBeforeTermEnd": 0,
      "term": "3-Year"
    }
  ],
  "product_dependencies": [
    {
      "name": "Requires",
      "products": [
        {
          "altVendorSku": "",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "Acme Corps Productivity Suite",
          "requiresCommitment": false,
          "shortDescription": "Short description about the product to sell",
          "sku": "4225-776-3234",
          "vendorName": "Acme Corps",
          "vendorSku": ""
        }
      ]
    }
  ],
  "product_id": "e91bba5e-a9a3-483f-b036-f80165d410e3"
}

Get product pricing

Get what a product costs you and its suggested price, for each billing term and quantity range, optionally for one company.

Inputs

Productproduct_idtextRequired
The product. Pick one, or give its id from an earlier step.
Companycompany_idtext
See this company's own pricing.

Outputs

countnumber
How many entries
pricinglist
One entry per billing term
product_idtext
The id it was asked about
Example output
{
  "count": 1,
  "pricing": [
    {
      "billingTerm": "Annual",
      "commitmentTerm": "1-Year",
      "commitmentTermInMonths": 12,
      "productId": "e91bba5e-a9a3-483f-b036-f80165d410e3",
      "productName": "Microsoft Office 365 E3",
      "rates": [
        {
          "chargeType": "Per Unit",
          "endQuantityRange": null,
          "partnerBuyRate": 145.8,
          "startQuantityRange": 1,
          "suggestedRetailPrice": 151.8
        }
      ],
      "type": "Flat",
      "unitOfMeasurement": "Each"
    }
  ],
  "product_id": "e91bba5e-a9a3-483f-b036-f80165d410e3"
}

Get product provisioning details

Get the questions an order for a product must answer, such as a Microsoft domain, with the choices each allows.

Inputs

Productproduct_idtextRequired
The product. Pick one, or give its id from an earlier step.

Outputs

countnumber
How many questions
product_idtext
The id it was asked about
provisioning_detailslist
Each question, by its key
Example output
{
  "count": 1,
  "product_id": "e91bba5e-a9a3-483f-b036-f80165d410e3",
  "provisioning_details": [
    {
      "description": "Do not include the TLD when entering your domain (e.g. mydomain.onmicrosoft.com should be entered as mydomain",
      "key": "msDomain",
      "label": "Desired .onmicrosoft.com Customer Domain Prefix",
      "possibleValues": null,
      "valueType": "Input",
      "values": []
    }
  ]
}

Get subscription

Get a subscription as it is now: product, quantity, price, cost, term, commitment and status.

Inputs

Subscriptionsubscription_idtextRequired
The subscription. Pick one, or give its id from an earlier step.

Outputs

subscriptionobject
The subscription
Example output
{
  "subscription": {
    "billingStart": "2021-01-01",
    "billingTerm": "Monthly",
    "commitmentTerm": {
      "endDate": "",
      "id": "",
      "term": ""
    },
    "companyId": "fe7a2d5f-4a14-43ff-940e-a65cda66474a",
    "createdDate": "2020-12-01T08:30:00Z",
    "currencyCode": "USD",
    "currentSubscriptionId": "",
    "endDate": "",
    "id": "05c587df-9e7d-4ef9-8218-0262198e36c9",
    "parentSubscriptionId": "",
    "partnerCost": 28.5,
    "price": 32.01,
    "productId": "e91bba5e-a9a3-483f-b036-f80165d410e3",
    "productName": "Microsoft Office 365 E3",
    "provisioningDetails": [],
    "quantity": 5,
    "startDate": "2021-01-01T08:30:00Z",
    "status": "Active",
    "updatedDate": "2020-12-01T08:30:00Z",
    "usageEligible": false,
    "vendorSkuId": "",
    "vendorSubscriptionId": ""
  }
}

Get subscription history

Get every change made to a subscription (quantity, term, price or product), most recent first.

Inputs

Subscriptionsubscription_idtextRequired
The subscription. Pick one, or give its id from an earlier step.

Outputs

countnumber
How many records
historylist
One record per change, most recent first
subscription_idtext
The id it was asked about
Example output
{
  "count": 1,
  "history": [
    {
      "billingStart": "2021-01-01",
      "billingTerm": "Monthly",
      "commitmentTerm": {
        "endDate": "",
        "id": "",
        "term": ""
      },
      "companyId": "fe7a2d5f-4a14-43ff-940e-a65cda66474a",
      "createdDate": "2020-12-01T08:30:00Z",
      "currencyCode": "USD",
      "currentSubscriptionId": "",
      "endDate": "",
      "id": "05c587df-9e7d-4ef9-8218-0262198e36c9",
      "parentSubscriptionId": "",
      "partnerCost": 28.5,
      "price": 32.01,
      "productId": "e91bba5e-a9a3-483f-b036-f80165d410e3",
      "productName": "Microsoft Office 365 E3",
      "provisioningDetails": [],
      "quantity": 5,
      "startDate": "2021-01-01T08:30:00Z",
      "status": "Active",
      "updatedDate": "2020-12-01T08:30:00Z",
      "usageEligible": false,
      "vendorSkuId": "",
      "vendorSubscriptionId": ""
    }
  ],
  "subscription_id": "05c587df-9e7d-4ef9-8218-0262198e36c9"
}

List companies

List your customer companies, filtered by status, place or billing settings. Gets one page; run it again with the next page number for more.

Inputs

Statusstatustext
Only companies in this state. Leave empty for all.One of: Active, Inactive (Inactive (no primary contacts yet)), Deleted.
Citycitytext
Only companies in this city.
Countrycountrytext
Only companies in this country.One of: AF (Afghanistan), AX (Åland Islands), AL (Albania), DZ (Algeria), AD (Andorra), AO (Angola), AI (Anguilla), AQ (Antarctica), AG (Antigua & Barbuda), AR (Argentina), and 239 more.
State or provincestate_or_provincetext
Only companies in this state.
Postal codepostal_codetext
Only companies with this postal code.
Pax8 bills the companybill_on_behalf_of_enabledtext
Only companies Pax8 bills for you (yes) or that you bill (no).One of: true (Yes), false (No).
Self-serviceself_service_allowedtext
Only companies that can (yes) or can't (no) order for themselves.One of: true (Yes), false (No).
Orders need approvalorder_approval_requiredtext
Only companies whose orders do (yes) or don't (no) wait for approval.One of: true (Yes), false (No).
Ordersorttext
How to sort the companies.One of: name,asc (Name, A to Z), name,desc (Name, Z to A), city,asc (City, A to Z), country,asc (Country, A to Z), stateOrProvince,asc (State or province, A to Z), postalCode,asc (Postal code, lowest first).
Pagepagenumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get on each page, 1 to 200. Defaults to 50.From 1 to 200.

Outputs

companieslist
The companies
countnumber
How many are on this page
has_moretrue/false
Whether there is a page after this one
pagenumber
This page's number, starting at 1
total_countnumber
How many there are in all, across every page
total_pagesnumber
How many pages there are
Example output
{
  "companies": [
    {
      "address": {
        "city": "Denver",
        "country": "US",
        "postalCode": "80210",
        "stateOrProvince": "Colorado",
        "street": "48918 Liberty Lane Ave",
        "street2": ""
      },
      "billOnBehalfOfEnabled": false,
      "externalId": "A123",
      "id": "a4dfc6bf-f02e-4a79-9844-66ba6c02ec3a",
      "name": "VFC Network, Inc",
      "orderApprovalRequired": false,
      "phone": "123-456-5555",
      "phoneCountryCallingCode": "",
      "phoneCountryCode": "",
      "phoneNumber": "",
      "selfServiceAllowed": false,
      "status": "Active",
      "updatedDate": "2023-08-11T11:33:12.314-0600",
      "website": "vfc-network-inc-liberty.com"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List contacts

List a company's contacts, newest first, with the kinds they are primary contact for.

Inputs

Companycompany_idtextRequired
The customer company. Pick one, or give its id from an earlier step.
Pagepagenumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get on each page, 1 to 200. Defaults to 50.From 1 to 200.

Outputs

company_idtext
The company
contactslist
The contacts
countnumber
How many are on this page
has_moretrue/false
Whether there is a page after this one
pagenumber
This page's number, starting at 1
total_countnumber
How many there are in all, across every page
total_pagesnumber
How many pages there are
Example output
{
  "company_id": "a4dfc6bf-f02e-4a79-9844-66ba6c02ec3a",
  "contacts": [
    {
      "createdDate": "2020-05-12",
      "email": "john.doe@vfc-network-inc-liberty.com",
      "firstName": "John",
      "id": "18d6329e-93f9-46a5-9df7-37e4c29d2840",
      "lastName": "Doe",
      "phone": "555-555-5555",
      "types": [
        {
          "primary": true,
          "type": "Admin"
        },
        {
          "primary": true,
          "type": "Billing"
        },
        {
          "primary": true,
          "type": "Technical"
        }
      ]
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List invoice items

List the line items of an invoice: each company, product, quantity, period, price and cost.

Inputs

Invoiceinvoice_idtextRequired
The invoice. Pick one, or give its id from an earlier step.
Pagepagenumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get on each page, 1 to 200. Defaults to 50.From 1 to 200.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is a page after this one
invoice_idtext
The invoice
itemslist
The line items
pagenumber
This page's number, starting at 1
total_countnumber
How many there are in all, across every page
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "has_more": false,
  "invoice_id": "17029935-36b0-4f0f-9d5e-c8af04f7b57a",
  "items": [
    {
      "amountDue": 27500,
      "billedByPax8": false,
      "billingFee": 0,
      "billingFeeRate": 0,
      "chargeType": "per",
      "companyId": "cc0ac255-7c0b-4123-ac8d-a6c280b85eae",
      "companyName": "Brick and Mortar Tech",
      "cost": 2500,
      "costTotal": 27500,
      "currencyCode": "USD",
      "description": "Microsoft Office E3",
      "details": "",
      "endPeriod": "2019-05-01",
      "externalId": "",
      "id": "6b0e2f5a-5c4c-4f0e-9f52-3d1f7f0a8b11",
      "offeredBy": "Pax8",
      "price": 50000,
      "productId": "de4ff8a5-e836-4412-89e7-03236c0641c4",
      "productName": "Microsoft Office E3",
      "purchaseOrderNumber": "N/A",
      "quantity": 11,
      "rateType": "single",
      "salesTax": 2200,
      "sku": "PAX-233-ukw0-9092",
      "startPeriod": "2019-04-01",
      "subTotal": 27500,
      "subscriptionId": "f6b60139-8ab6-45f4-b808-354ebbe53070",
      "term": "Monthly",
      "total": 550000,
      "type": "subscription",
      "unitOfMeasure": "User",
      "vendorName": "Microsoft"
    }
  ],
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List invoices

List Pax8's invoices to you with their totals, balances and status, filtered by status, date or company. Gets one page; run it again with the next page number for more.

Inputs

Statusstatustext
Only invoices in this state.One of: Unpaid, Paid, Void, Carried, Nothing Due, Credited.
Invoiced on or afterinvoice_date_fromdate
Only invoices dated on or after this day.
Invoiced on or beforeinvoice_date_todate
Only invoices dated on or before this day.
Due ondue_datedate
Only invoices due on this day.
Companycompany_idtext
Only invoices for this company.
Ordersorttext
How to sort the invoices.One of: invoiceDate,desc (Invoice date, newest first), invoiceDate,asc (Invoice date, oldest first), dueDate,desc (Due date, latest first), dueDate,asc (Due date, earliest first), total,desc (Total, highest first), balance,desc (Balance, highest first), status,asc (Status).
Pagepagenumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get on each page, 1 to 200. Defaults to 50.From 1 to 200.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is a page after this one
invoiceslist
The invoices
pagenumber
This page's number, starting at 1
total_countnumber
How many there are in all, across every page
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "has_more": false,
  "invoices": [
    {
      "balance": 560470.66,
      "carriedBalance": 17204372.33,
      "companyId": "",
      "currencyCode": "USD",
      "dueDate": "2020-09-15",
      "externalId": "",
      "id": "17029935-36b0-4f0f-9d5e-c8af04f7b57a",
      "invoiceDate": "2020-09-01",
      "invoiceNumber": "2020-1-101204",
      "partnerName": "My Partner Name",
      "status": "Paid",
      "total": 17432960
    }
  ],
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List orders

List orders, for every company or one. Gets one page; run it again with the next page number for more.

Inputs

Companycompany_idtext
Only this company's orders.
Pagepagenumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get on each page, 1 to 200. Defaults to 50.From 1 to 200.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is a page after this one
orderslist
The orders
pagenumber
This page's number, starting at 1
total_countnumber
How many there are in all, across every page
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "has_more": false,
  "orders": [
    {
      "companyId": "fe7a2d5f-4a14-43ff-940e-a65cda66474a",
      "createdDate": "2020-12-01",
      "id": "8e42de97-6bfe-4db5-864b-d2e4b18c71e2",
      "isScheduled": false,
      "lineItems": [
        {
          "billingTerm": "Monthly",
          "commitmentTermId": "",
          "id": "4915142b-1b3f-4488-9e68-e979dc661130",
          "lineItemNumber": 1,
          "parentLineItemNumber": 0,
          "parentSubscriptionId": "",
          "productId": "e91bba5e-a9a3-483f-b036-f80165d410e3",
          "provisionStartDate": "2021-01-01T08:30:00Z",
          "provisioningDetails": [],
          "quantity": 5,
          "subscriptionId": "efcf8cb8-63fc-4dc4-8caa-6d6810ee8a97"
        }
      ],
      "orderedBy": "",
      "orderedByUserEmail": "",
      "orderedByUserId": ""
    }
  ],
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List products

Search the products you can sell in Pax8's catalogue by name, SKU or vendor. Gets one page; run it again with the next page number for more.

Inputs

Searchsearchtext
Words in the product's name or SKU.
Vendorvendor_nametext
Only products from this vendor, such as Microsoft.
Ordersorttext
How to sort the products.One of: name,asc (Name, A to Z), name,desc (Name, Z to A), vendor,asc (Vendor, A to Z), vendor,desc (Vendor, Z to A).
Pagepagenumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get on each page, 1 to 200. Defaults to 50.From 1 to 200.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is a page after this one
pagenumber
This page's number, starting at 1
productslist
The products
total_countnumber
How many there are in all, across every page
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "products": [
    {
      "altVendorSku": "",
      "id": "e91bba5e-a9a3-483f-b036-f80165d410e3",
      "name": "Microsoft Office 365 E3",
      "requiresCommitment": false,
      "shortDescription": "Microsoft Office 365 E3 includes fully installed Office applications across multiple devices, email hosting, HD video conferencing, and features to support compliance.",
      "sku": "MST-OFC-EE3-C100",
      "vendorName": "Microsoft",
      "vendorSku": "796B6B5F-613C-4E24-A17C-EBA730D49C02"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

List subscriptions

List subscriptions with their product, quantity, price and status, filtered by company, product, status or term. Gets one page; run it again with the next page number for more.

Inputs

Companycompany_idtext
Only this company's subscriptions.
Productproduct_idtext
Only subscriptions to this product.
Statusstatustext
Only subscriptions in this state.One of: Active, Cancelled, PendingManual (Pending (manual provisioning)), PendingAutomated (Pending (automated provisioning)), PendingCancel (Pending cancellation), WaitingForDetails (Waiting for details), Trial, Converted, PendingActivation (Pending activation), Activated.
Billing termbilling_termtext
Only subscriptions billed on this term.One of: Monthly, Annual, 2-Year (2 years), 3-Year (3 years), One-Time (One time), Trial, Activation.
Ordersorttext
How to sort the subscriptions.One of: createdDate,desc (Newest first), createdDate,asc (Oldest first), quantity,desc (Quantity, highest first), quantity,asc (Quantity, lowest first), price,desc (Price, highest first), price,asc (Price, lowest first), startDate,desc (Start date, latest first), startDate,asc (Start date, earliest first), endDate,desc (End date, latest first), endDate,asc (End date, earliest first), billingStart,desc (Billing start, latest first), billingStart,asc (Billing start, earliest first).
Pagepagenumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get on each page, 1 to 200. Defaults to 50.From 1 to 200.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is a page after this one
pagenumber
This page's number, starting at 1
subscriptionslist
The subscriptions
total_countnumber
How many there are in all, across every page
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "subscriptions": [
    {
      "billingStart": "2021-01-01",
      "billingTerm": "Monthly",
      "commitmentTerm": {
        "endDate": "",
        "id": "",
        "term": ""
      },
      "companyId": "fe7a2d5f-4a14-43ff-940e-a65cda66474a",
      "createdDate": "2020-12-01T08:30:00Z",
      "currencyCode": "USD",
      "currentSubscriptionId": "",
      "endDate": "",
      "id": "05c587df-9e7d-4ef9-8218-0262198e36c9",
      "parentSubscriptionId": "",
      "partnerCost": 28.5,
      "price": 32.01,
      "productId": "e91bba5e-a9a3-483f-b036-f80165d410e3",
      "productName": "Microsoft Office 365 E3",
      "provisioningDetails": [],
      "quantity": 5,
      "startDate": "2021-01-01T08:30:00Z",
      "status": "Active",
      "updatedDate": "2020-12-01T08:30:00Z",
      "usageEligible": false,
      "vendorSkuId": "",
      "vendorSubscriptionId": ""
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

List usage lines

List the usage recorded on one day under a usage summary: each product, quantity, charge and profit.

Inputs

Usage summary IDusage_summary_idtextRequired
The usage summary's id, from 'List usage summaries' or an earlier step.
Dayusage_datedateRequired
The day to get usage for. Run it once per day.
Productproduct_idtext
Only usage of this product.
Pagepagenumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get on each page, 1 to 200. Defaults to 50.From 1 to 200.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is a page after this one
pagenumber
This page's number, starting at 1
total_countnumber
How many there are in all, across every page
total_pagesnumber
How many pages there are
usage_datetext
The day (YYYY-MM-DD)
usage_lineslist
The usage lines
usage_summary_idtext
The usage summary
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "total_count": 1,
  "total_pages": 1,
  "usage_date": "2020-01-14",
  "usage_lines": [
    {
      "currencyCode": "USD",
      "currentCharges": 15.99,
      "currentProfit": 5.61,
      "isTrial": false,
      "partnerTotal": 10.38,
      "productId": "61bf3a55-f1da-4efd-88eb-bf362b0ad51e",
      "productName": "Proofpoint Essentials - Professional",
      "quantity": 3,
      "unitOfMeasure": "User",
      "unitPrice": 5.33,
      "usageDate": "2020-01-14",
      "usageSummaryId": "52d8d4bc-59db-48fe-9aa7-95bed562ff95"
    }
  ],
  "usage_summary_id": "52d8d4bc-59db-48fe-9aa7-95bed562ff95"
}

List usage summaries

List this month's usage charges for a usage-billed subscription, such as Azure, one summary per resource group.

Inputs

Subscriptionsubscription_idtextRequired
The usage-billed subscription.
Companycompany_idtext
Only this company's usage.
Resource groupresource_grouptext
Only this resource group, such as Company 1.
Pagepagenumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get on each page, 1 to 200. Defaults to 50.From 1 to 200.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is a page after this one
pagenumber
This page's number, starting at 1
subscription_idtext
The subscription
total_countnumber
How many there are in all, across every page
total_pagesnumber
How many pages there are
usage_summarieslist
The usage summaries
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "subscription_id": "8d04ad8c-456a-4b1d-9abe-a42ae526f683",
  "total_count": 1,
  "total_pages": 1,
  "usage_summaries": [
    {
      "companyId": "ede334e7-d1c7-4e0a-822d-dee891f6ce9a",
      "currencyCode": "USD",
      "currentCharges": 100.56,
      "id": "52d8d4bc-59db-48fe-9aa7-95bed562ff95",
      "isTrial": false,
      "partnerTotal": 86.456,
      "productId": "b3bb9455-c454-4efa-9be8-15b86caf6933",
      "resourceGroup": "Company 1",
      "subscriptionId": "8d04ad8c-456a-4b1d-9abe-a42ae526f683",
      "vendorName": "Microsoft"
    }
  ]
}

Place order

Buy a product for a company. This is a real purchase billed to your Pax8 account; turn on 'Check only' to have Pax8 check it without placing it.

Inputs

Companycompany_idtextRequired
The customer company the order is for.
Productproduct_idtextRequired
The product to buy.
QuantityquantitynumberRequired
How many licences or units to buy.From 1 to 100000.
Billing termbilling_termtextRequired
How often the company is billed. 'Get product pricing' lists the terms a product offers.One of: Monthly, Annual, 2-Year (2 years), 3-Year (3 years), One-Time (One time), Trial, Activation.
Commitment termcommitment_term_idtext
Needed when the product requires a commitment. Pick one of the product's terms.
Startprovision_start_datedate and time
When to provision it. Leave empty to start now.
Provisioning detailsprovisioning_detailsobject
Answers the product needs, keyed as 'Get product provisioning details' lists them, for example {"msDomain": "acmedental"}.
Parent subscriptionparent_subscription_idtext
For an add-on: the company's subscription it depends on, as 'Get product dependencies' requires.
Check onlyvalidate_onlytrue/false
Have Pax8 check the order without placing it, so nothing is bought.Default: false.

Outputs

orderobject
The order, with the subscription it created
validated_onlytrue/false
True when Pax8 only checked the order
Example output
{
  "order": {
    "companyId": "fe7a2d5f-4a14-43ff-940e-a65cda66474a",
    "createdDate": "2020-12-01",
    "id": "8e42de97-6bfe-4db5-864b-d2e4b18c71e2",
    "isScheduled": false,
    "lineItems": [
      {
        "billingTerm": "Monthly",
        "commitmentTermId": "",
        "id": "4915142b-1b3f-4488-9e68-e979dc661130",
        "lineItemNumber": 1,
        "parentLineItemNumber": 0,
        "parentSubscriptionId": "",
        "productId": "e91bba5e-a9a3-483f-b036-f80165d410e3",
        "provisionStartDate": "2021-01-01T08:30:00Z",
        "provisioningDetails": [],
        "quantity": 5,
        "subscriptionId": "efcf8cb8-63fc-4dc4-8caa-6d6810ee8a97"
      }
    ],
    "orderedBy": "",
    "orderedByUserEmail": "",
    "orderedByUserId": ""
  },
  "validated_only": false
}

Update company

Change a company's name, address, phone, website, reference or billing settings. Fields left empty keep their value.

Inputs

Companycompany_idtextRequired
The customer company. Pick one, or give its id from an earlier step.
Company namenametext
A new name. Leave empty to keep it.
Streetstreettext
A new street address. Leave empty to keep it.
Street, line 2street2text
A new second line. Leave empty to keep it.
Citycitytext
A new city. Leave empty to keep it.
State or provincestate_or_provincetext
A new state or province. Leave empty to keep it.
Postal codepostal_codetext
A new postal code. Leave empty to keep it.
Countrycountrytext
A new country. Leave empty to keep it.One of: AF (Afghanistan), AX (Åland Islands), AL (Albania), DZ (Algeria), AD (Andorra), AO (Angola), AI (Anguilla), AQ (Antarctica), AG (Antigua & Barbuda), AR (Argentina), and 239 more.
Phonephonetext
A new main phone number. Leave empty to keep it.
Websitewebsitetext
A new website. Leave empty to keep it.
External IDexternal_idtext
A new reference of your own. Leave empty to keep it.
Pax8 bills the companybill_on_behalf_of_enabledtext
Yes if Pax8 bills the company directly on your behalf; no if you bill it.One of: true (Yes), false (No).
Self-serviceself_service_allowedtext
Whether the company can order for itself in Pax8.One of: true (Yes), false (No).
Orders need approvalorder_approval_requiredtext
Whether the company's own orders wait for your approval.One of: true (Yes), false (No).

Outputs

companyobject
The company
Example output
{
  "company": {
    "address": {
      "city": "Denver",
      "country": "US",
      "postalCode": "80210",
      "stateOrProvince": "Colorado",
      "street": "48918 Liberty Lane Ave",
      "street2": ""
    },
    "billOnBehalfOfEnabled": false,
    "externalId": "A123",
    "id": "a4dfc6bf-f02e-4a79-9844-66ba6c02ec3a",
    "name": "VFC Network, Inc",
    "orderApprovalRequired": false,
    "phone": "123-456-5555",
    "phoneCountryCallingCode": "",
    "phoneCountryCode": "",
    "phoneNumber": "",
    "selfServiceAllowed": false,
    "status": "Active",
    "updatedDate": "2023-08-11T11:33:12.314-0600",
    "website": "vfc-network-inc-liberty.com"
  }
}

Update contact

Change a contact's name, email, phone or what they are primary contact for. Fields left empty keep their value.

Inputs

Companycompany_idtextRequired
The customer company. Pick one, or give its id from an earlier step.
Contactcontact_idtextRequired
The contact. Pick one, or give its id from an earlier step.
First namefirst_nametext
A new first name. Leave empty to keep it.
Last namelast_nametext
A new last name. Leave empty to keep it.
Emailemailtext
A new email address. Leave empty to keep it.
Phonephonetext
A new phone number. Leave empty to keep it.
Primary contact forprimary_forlist
Make this person the primary contact for exactly these, replacing what they were. Leave empty to keep it.One or more of: Admin, Billing, Technical.

Outputs

company_idtext
The company the contact is in
contactobject
The contact
Example output
{
  "company_id": "a4dfc6bf-f02e-4a79-9844-66ba6c02ec3a",
  "contact": {
    "createdDate": "2020-05-12",
    "email": "john.doe@vfc-network-inc-liberty.com",
    "firstName": "John",
    "id": "18d6329e-93f9-46a5-9df7-37e4c29d2840",
    "lastName": "Doe",
    "phone": "555-555-5555",
    "types": [
      {
        "primary": true,
        "type": "Admin"
      },
      {
        "primary": true,
        "type": "Billing"
      },
      {
        "primary": true,
        "type": "Technical"
      }
    ]
  }
}

Update subscription

Change a subscription's quantity, price, billing term or start. Adding licences is billed to your Pax8 account.

Inputs

Subscriptionsubscription_idtextRequired
The subscription. Pick one, or give its id from an earlier step.
Quantityquantitynumber
The new number of licences. More are billed to you at once; fewer only if the commitment allows it.From 0 to 100000.
Pricepricenumber
The new price you charge the company per unit, such as 15.39.At least 0.
Billing termbilling_termtext
A new billing term. Leave empty to keep it.One of: Monthly, Annual, 2-Year (2 years), 3-Year (3 years), One-Time (One time), Trial, Activation.
Startstart_datedate and time
A new start date and time. Leave empty to keep it.

Outputs

subscriptionobject
The subscription
Example output
{
  "subscription": {
    "billingStart": "2021-01-01",
    "billingTerm": "Monthly",
    "commitmentTerm": {
      "endDate": "",
      "id": "",
      "term": ""
    },
    "companyId": "fe7a2d5f-4a14-43ff-940e-a65cda66474a",
    "createdDate": "2020-12-01T08:30:00Z",
    "currencyCode": "USD",
    "currentSubscriptionId": "",
    "endDate": "",
    "id": "05c587df-9e7d-4ef9-8218-0262198e36c9",
    "parentSubscriptionId": "",
    "partnerCost": 28.5,
    "price": 32.01,
    "productId": "e91bba5e-a9a3-483f-b036-f80165d410e3",
    "productName": "Microsoft Office 365 E3",
    "provisioningDetails": [],
    "quantity": 6,
    "startDate": "2021-01-01T08:30:00Z",
    "status": "Active",
    "updatedDate": "2020-12-01T08:30:00Z",
    "usageEligible": false,
    "vendorSkuId": "",
    "vendorSubscriptionId": ""
  }
}

On this page