Pax8 API PowerShell Module

A PowerShell module for Pax8 partner and authentication endpoints.
Explore the docs

Report Bug | Request Feature

About

This module provides PowerShell commands for working with Pax8 partner API resources, including:

• 🏢 Companies
• 👤 Contacts
• 🧾 Invoices
• 🛒 Orders
• 📦 Products
• 🔁 Subscriptions
• 📊 Usage summaries

The module uses the Pax8 OAuth client credentials flow for authentication. For current API reference material, see the Pax8 developer documentation.

Getting Started

The Pax8 API requires a developer application with a client_id and client_secret.

Installation

Install-Module -Name 'Pax8-API'

Usage

Create a credential where the username is your Pax8 client_id and the password is your Pax8 client_secret, then connect:

$credential = Get-Credential
Connect-Pax8 -credential $credential

Example read operations:

Get-Pax8Company -page 0 -size 10
Get-Pax8Product -search 'Microsoft' -page 0 -size 10
Get-Pax8Invoice -page 0 -size 10

For a complete command list, see Pax8-API.md.

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/CoolFeature)
3. Commit your Changes (git commit -m 'Add some CoolFeature')
4. Push to the Branch (git push origin feature/CoolFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.