Overview

The Get Upgrade Price endpoint allows integrations to retrieve pricing information when upgrading an existing deliverable for a model. This is useful for scenarios where a user wants to transition one deliverable to another, such as upgrading a Roof Only model to a Complete 3D model.

The response provides a breakdown of the current payment status and the additional amount required for the upgrade. All monetary values are returned in cents. For example, if the pending value is 7500, the cost to proceed with the Deliverable Change Request would be $75.

Using this pricing data, your integration can determine whether to initiate a Deliverable Change Request, which would charge the payment method on file and grant access to the upgraded deliverable.

Obtaining the model_id

Your integration can obtain the specific model ID(s) by calling the Show Job Details endpoint.

Sample Response Body

{
    "owed": 3500,       // The amount currently owed for the existing deliverable (in cents)
    "paid": 0,          // The amount that has already been paid for this model (in cents)
    "pending": 7500     // The additional amount that would be owed if the deliverable is 	                              upgraded (in cents)
}