[3rd Party Integrator] Refresh Token Authorization for 3rd Party Apps
There was a mistake on the documents for refresh token lifetime limit. The docs stated this was alive for 1 year, which is not the case. The real lifecycle is 90 days for a refresh token before the user is required to re-authorize the app.
[Partner] Enhanced Product Search Capabilities Added to Product API
The /v1/products
endpoint now supports a powerful new search
parameter that enables querying across multiple product attributes, including product name, description, and ID. This enhancement provides more flexible and comprehensive search functionality for your product catalog.
[Partner] Product Api Get Product By Id includes long description
The Product API now includes the long description for a product under the description field.
[Vendor] Provisioning API Now Has New Request Type "Renewal"
The Provisioning API now has a new request type of Renewal
. The newRenewal
type represents a request to confirm the continuation of an existing subscription for another commitment term.
[Vendor] Usage API can accumulate usage instead of just overwriting
Before this update, the Usage API would always react to multiple batches of usage sent on the same day in one way: it would overwrite old batches with the new batch. Now this behavior can be changed. Vendors can now send a new parameter called overwriteSameDayUsage
when posting usage, and if set to false, usage batches will accumulate instead of overwrite one another. Learn more here
[Vendor] Usage API supports aggregate partner pricing
The usage api has a new endpoint that accepts a new type called Aggregate Usage Line. Aggregate Usage Lines have a required partnerAggregateQuantity
field, which will be used in lieu of the quantity
when calculating the partner price for the usage line. More here.
[Partner] Enhanced subscriptionId field on Invoice Items
Updated the subscriptionId
field on Invoice Items to contain subscription identifiers for all product types, not just 'subscription' or 'prorate' types. This enhancement allows partners to link any invoice line item to its relevant subscription details. Products without subscription IDs (like BitTitan migration) will still return null values. Relevant endpoint.
[Partner] New partner audience for Access Token creation
The new default audience to create an access token for Partner Endpoints should has been updated to https://api.pax8.com
.
[Partner] New quoting endpoints
A new set of partner focused endpoints to manage quoting have been released. Now partners can create/manage their quotes.
[Partner] Invoice endpoint - Added subscriptionId
API: Added subscriptionId
to the Invoice Items (/invoice/{id}/items
) endpoint