Provision Request
Overview
A ProvisionRequest
contains basic information about a purchase which cannot change. This includes things such as partnerId, partnerAddress, companyAddress, productId, etc
For collecting non-static information such as an admin email address or phone number, you should refer the Provision Details section of our guide which contains information a user entered at checkout.
Endpoints
List All Provision Requests
- Lists All Provision Requests
- GET /provision-requests
Get A Provision Request
- Gets a Single Provision by ID
- GET v2/provision-requests/:id
List All Unfulfilled Provision Requests
- Lists All Unfulfilled Provision Requests
- GET /provision-requests/unfulfilled
The Provision Request Object
{
"id": "eb77429f-b313-4916-9bed-ccc1c373dff7",
"partnerId": "2bb54fa0-21ed-481e-8627-26e3ee9e9e02",
"partnerName": "Example Partner Name",
"partnerDomain": "partner.com",
"partnerAddress": {
"street": "123 Partner Avenue",
"street2": "Unit A",
"city": "Denver",
"postcode": "80210",
"country": "US",
"stateOrProvince": "Colorado"
},
"partnerEnrollmentId": "7bb64fa0-21ed-481e-8627-26e3gg9e9e02",
"companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"companyName": "Example Company Name",
"companyDomain": "company.com",
"companyAddress": {
"street": "123 Company Avenue",
"street2": "Unit A",
"city": "Denver",
"postcode": "80210",
"country": "US",
"stateOrProvince": "CO"
},
"productId": "ada2a119-9892-4a91-8bae-b0bb3b0e81a1",
"oldProductId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"productName": "Product ABC",
"quantity": 0,
"subscriptionId": "475df9f9-2558-4f91-903b-5130dad67064",
"type": "NetNew",
"createdDate": "2025-07-09T19:52:34.641303Z",
"trialEndDate": "2025-08-01T19:52:34.641303Z",
"trialAutoConverts": true,
"commitmentTermEndDate": "2026-07-31T19:50:02Z",
"commitmentTermMonths": 12,
"commitment": {
"term": {
"months": 12,
"endDate": "2026-07-31T19:50:02Z"
},
"volume": {
"minAmount": 250.0000,
"maxAmount": 500.0000,
"unitOfMeasure": "USD",
"months": 1
}
},
"billingTerm": "Monthly"
}
Null fields will be omitted.
Additional Information
Commitments
Terms
If you require partners to agree to a set commitment term when buying a product, you can have that configured in Pax8. For example, if you require partners to buy a full year of service at a time, Pax8 can configure a 12 month commitment term for your products.
In this example, any ProvisionRequest
for your product would include a commitment.term.months
field which would be 12, and a commitment.term.endDate
field, which would contain a date 12 months in the future from the purchase date.
Volume
In addition to time only based commitment terms, Pax8 supports volume commitments that specify minimum and (optionally) maximum volume requirements for subscriptions for a certain unit and length of time. Volume commitments work alongside time-based commitments to provide more flexible commitment options.
Note: Volume commitments are always paired with time-based commitments. Volume-only commitments are not currently available.
Backward Compatibility
For backward compatibility, provision requests continue to include the legacy commitment fields:
commitmentTermMonths
- Duration in months (deprecated, usecommitment.term.months
)commitmentTermEndDate
- End date (deprecated, usecommitment.term.endDate
)
Billing Terms
All provision requests will contain a billingTerm
whose value represents the frequency at which the product is billed. The possible values for billingTerm
are as follows:
- One-Time
- Monthly
- Annual
- 2 Year
- 3 Year
- Trial
- Activation
Updated 8 days ago