Skip to navigation
Configuration APIQuote Versions

Get the deal summary of a quote version

Contract values (TCV, ACV, contracted ARR), discounts and commitments of the quote version’s pricing plan subscription, calculated with the invoice engine. Returns 404 when no summary can be calculated, 409 while a change to the configuration is still being processed (retry later) and 422 when the invoice engine cannot calculate it, e.g. for a term with too many invoices. Requires the QUOTE.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdstringRequiredDefaults to
The ID of the resource to be requested.

Headers

x-platform-idstringOptional
Platform ID.

Response

OK
object_typestring or nullOptionalRead-only
The type of the object.
quote_version_idstring or nullOptionalRead-only
The ID of the quote version this summary is calculated for.
computed_atstring or nullOptionalRead-only
The moment the summary was calculated.
currencystring or nullOptionalRead-only
The billing currency of the pricing plan subscriptions. All amounts in the summary are in this currency.
termobject or nullOptional

The term of the deal: from the earliest start to the latest end of the terms of its pricing plan subscriptions.

tcvobject or nullOptional

Total contract value: everything invoiced over the term, net of discounts and including commitments. Usage counts as zero.

list_tcvobject or nullOptional
The total contract value at list prices, before discounts and overrides.
acvobject or nullOptional

Annual contract value: the sum of the annual contract values of the pricing plan subscriptions.

contracted_arrobject or nullOptional

Recurring contract value per year: (TCV minus one-off fees) divided by the term in years.

contracted_arr_fully_rampedobject or nullOptional

Annual recurring revenue at the end of the term: the sum of the fully ramped ARRs of the pricing plan subscriptions.

one_off_totalobject or nullOptional

The total of the one-off fees over the term.

commitment_totalobject or nullOptional

The total of the commitment top-ups over the term.

discount_totalobject or nullOptional
The total of the configured discounts over the term, as a positive amount. Includes the unallocated discounts.
unallocated_discount_totalobject or nullOptional
The part of the discount total that could not be attributed to a single line, such as discounts on the invoice total.
markup_totalobject or nullOptional
The total of the configured markups over the term.
estimated_usage_totalobject or nullOptional
Reserved for the estimated usage over the term. Not calculated yet.
estimated_tcvobject or nullOptional
Reserved for the total contract value including estimated usage. Not calculated yet.
blended_discountobject or nullOptional
The discount from list to quoted total contract value, as an amount and as a percentage. Absent when the list value is zero.
variable_notestring or nullOptionalRead-only

Explains how usage-based lines are included in the summary.

pricing_plan_subscriptionslist of objects or nullOptionalRead-only
The metrics, lines and schedules per pricing plan subscription of the quote version.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error