Skip to main content
POST
Revoke contract assessment override

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required
decision_id
string
required

Body

application/json
reason
string
required

Why the decision was taken. Required, not empty.

Minimum string length: 1
Example:

"Price confirmed by the pricing committee."

Response

id
string
required

Unique identifier of the contract assessment.

Example:

"caa_2Lm9xQ1z4Ha7Gk"

ledger_id
string
required

Identifier of the ledger the record belongs to.

Example:

"led_8Hq2nZ0kLm4x1P"

subscription_id
string
required

Identifier of the subscription holding the contract.

Example:

"sub_Gk2Lm9xQ1z4Ha7"

customer_id
string
required

Identifier of the customer.

Example:

"cus_Lm9xQ1z4Ha7Gk2"

term_start_at
string<date-time>
required

Start of the assessed contract term.

Example:

"2024-12-20T16:04:11Z"

term_end_at
string<date-time> | null
required

End of the assessed contract term: the end of its last day in the subscription's timezone, or null when the subscription cannot be found.

Example:

"2024-12-20T16:04:11Z"

timezone
string | null
required

Timezone of the subscription, in which the term's start and end are day boundaries, or null when the subscription cannot be found.

Example:

"Europe/Paris"

policy_id
string
required

Revenue policy the contract is assessed under.

Example:

"rpol_3fJ8kZx1Lq9a2B"

policy_name
string
required

Name of the revenue policy.

Example:

"Enterprise contracts"

policy_version
integer
required

Version number of the revenue policy the contract is pinned to.

latest_version
integer
required

Number of the latest assessment version.

applied_version
integer | null
required

Number of the assessment version driving recognition, or null while none does.

currency
enum<string>
required

Contract currency.

Available options:
EUR,
AED,
AFN,
XCD,
ALL,
AMD,
AOA,
ARS,
USD,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
XOF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
NOK,
BWP,
BYR,
BZD,
CAD,
CDF,
XAF,
CHF,
NZD,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
ANG,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
MAD,
ERN,
ETB,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRO,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
XPF,
NGN,
NIO,
NPR,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
SSP,
STD,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
UYU,
UZS,
VEF,
VND,
VUV,
WST,
YER,
ZAR,
ZMW,
ZWL
Example:

"EUR"

transaction_price
number
required

Consideration of the contract term allocated across its obligations. Expressed in currency's smallest unit.

invoiced_amount
number
required

Amount billed so far on the contract's revenue recognition schedules, net of credit notes and voids, in the contract currency. Expressed in currency's smallest unit.

recognized_amount
number
required

Revenue recognized so far on the contract's revenue recognition schedules, in the contract currency. Expressed in currency's smallest unit.

deferred_amount
number
required

Current deferred revenue position of the contract (billed, not yet recognized), in the contract currency. Expressed in currency's smallest unit.

unbilled_amount
number
required

Current unbilled revenue position of the contract (recognized, not yet billed), in the contract currency. Expressed in currency's smallest unit.

calculation_status
enum<string>
required

Whether the assessment could be computed, or misses an input such as a standalone selling price.

Available options:
complete,
incomplete
review_status
enum<string>
required

Whether the assessment awaits, passed or failed a review.

Available options:
not_required,
pending,
approved,
rejected
recognition_status
enum<string>
required

eligible when the version may drive recognition, held while an input, a review or a blocking exception holds it.

Available options:
eligible,
held
open_exception_count
integer
required

Number of open exceptions of the contract.

updated_at
string<date-time>
required

When the record last changed.

Example:

"2024-12-20T16:04:11Z"

version
object
required

The assessment version shown: the latest one unless another was requested.

obligations
object[]
required

Performance obligations of the version, in order.

exceptions
object[]
required

Open exceptions of the contract.

decisions
(Approval, rejection or dismissal · object | Override · object | Delivery · object)[]
required

Review decisions on the contract, newest first.

versions
object[]
required

Every version of the assessment, newest first.