Skip to content
Revenue API
/
/
Expire variable considera...

Expire variable consideration

Request

Purpose

Expires, for the given amount, a variable consideration previously applied to a line, for example when an unused rebate or credit lapses.

When to use

  • The estimate behind a variable consideration will not be realized.
  • Use the id from rcLineAdjustmentRecords returned by apply-vc as rcLinePriceAdjustmentId.
Security
bearerAuth
Path
rcIdinteger, (int64)required

Revenue contract ID.

Example:111442
Headers
X-REV-BOOK-IDinteger, (int64)

Revenue book to work in. Defaults to 1 (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books.

Default:1
Example:1
Zuora-Request-Idstring, <= 64 characters

Optional correlation ID, echoed in the traceId response header.

Example:b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11
Bodyapplication/jsonrequired
rcLinePriceAdjustmentIdinteger, (int64), <= 2147483647required

Line price adjustment to expire (rcLineAdjustmentRecords[].id from apply-vc).

amountnumber, (double)required

Amount to expire.

objectVersioninteger, (int64)

Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.

Example:5
{
  "rcLinePriceAdjustmentId": 7001,
  "amount": 250
}

Responses

Processed. success: true means the action completed; success: false means a business rule rejected it and message explains why.

Headers
traceIdstring

Correlation ID of the request. Quote it when you contact Zuora Global Support.

Bodyapplication/json
successbooleanrequired

true when the action completed. false when the revenue engine rejected it under a business rule; see message.

processIdstringrequired

Unique ID generated for this request. Quote it when you contact Zuora Global Support.

messagestring

Result message from the revenue engine. May be empty on success.

changeIdsstring

Comma-separated IDs of records changed by the action, when the action reports them. Omitted otherwise.

Response
{
  "success": true,
  "processId": "3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11",
  "message": "Variable consideration expired successfully"
}