Provisioning Overview

Below is a quick introduction to the basics of using the provisioning endpoints.

Base Url

The base url for all provisioning requests is https://api.pax8.com/v2

The Pax8 Provisioning API provides a way for Vendors to easily fulfill Pax8 Orders. Here are a few key terms:

Provision - To fulfill a Pax8 Order by creating the necessary cloud resources, communicating
results to Pax8, and providing credentials for the cloud resources to the Partner.
Partner - A Pax8 Partner, also known as a Managed Service Provider (MSP).
Manages cloud software for a Company and are Pax8's primary users.
Company - A Pax8 Company, also known as an End User. A Company buys
cloud software from a Partner
Subscription - A record in Pax8 for a specific Partner/Company/Product combination in the Pax8 system.
Provisioner - An entity that provisions Pax8 orders, also known as a Pax8 Vendor. More here
ProvisionRequest - Contains basic information about a purchase which cannot change. More here
ProvisionDetail - Contains information a user entered at checkout. More here
ProvisionAttempt - Represents an attempt by Pax8 to send your system a Provision Notification. More here
Provison Notification - An outbound message from Pax8 comprising of a ProvisionRequest, ProvisionDetail, and ProvisionAttempt. More here
ProvisionResult - Represents the end result for a given ProvisionAttempt (Success or Fail). More here

Partner orders from Pax8
Pax8 sends a Provision Notification via Webhook to the vendor
Provisioner provisions cloud resources
Provisioner emails Partner information and credentials for cloud resources
Provisioner notifies Pax8 with ProvisionResults using the Provisioning API
Partner has a Subscription in Pax8 they can then modify or cancel at any time

You can find the complete OpenAPI Spec for the provisioning API here