Skip to content
Revenue API
/
/
Release a hold from contr...

Release a hold from contract charges

Request

Purpose

Releases a revenue hold previously applied to selected charges, so the blocked revenue recognition (or transfer) resumes. The release comment and reason are recorded for audit.

When to use

  • The condition behind the hold is met, for example acceptance was received or the audit finished.
  • The hold definition must allow manual release (flags.allowManualRelease is Y).

Behavior notes

Each item in items must include chargeNumber.

Security
bearerAuth
Path
rcIdinteger, (int64)required

Revenue contract ID.

Example:111442
holdIdinteger, (int64)required

Revenue hold definition ID. List holds with GET /revenue-holds.

Example:20
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
commentsstring

Release comment.

Default:""
reasonstring

Release reason.

Default:""
itemsArray of objects, non-empty(ReleaseHoldItem)required

Items to release. Note that this field is items, while apply-hold uses lines.

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
{
  "comments": "Audit complete",
  "items": [
    { … }
  ]
}

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": "Hold released successfully"
}