Skip to content
Revenue API
/
/
Retrieve a revenue hold d...

Retrieve a revenue hold definition

Request

Purpose

Returns one revenue hold definition, at any hold level.

When to use

  • Confirm a hold's level, type, and manual apply or release settings before you apply or release it on a contract.
Security
bearerAuth
Path
holdIdinteger, (int64)required

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

Example:20
Headers
Zuora-Request-Idstring, <= 64 characters

Optional correlation ID, echoed in the traceId response header.

Example:b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11
cURL
curl -i -X GET \
  https://one.zuora.com/revenue/services/v1/revenue-holds/20 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Zuora-Request-Id: b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11'

Responses

The revenue hold definition.

Headers
traceIdstring

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

Bodyapplication/json
idinteger, (int64)

Hold definition ID (holdId).

namestring

Hold name.

descriptionstring or null

Hold description.

startDatestring or null

Date the hold definition becomes effective.

endDatestring or null

Date the hold definition stops being effective.

eventIdinteger or null, (int64)

Release event linked to the hold.

expiryFieldNamestring or null

Field used to calculate automatic expiry of the hold.

expiryNumberTypestring or null

Unit of the expiry duration, such as days or months.

expiryDurationinteger or null, (int64)

Number of expiry units after which the hold expires.

flagsobject(RevenueHoldFlags)

Configuration flags of a revenue hold definition.

createdPeriodIdinteger, (int64)

Period in which the hold was created.

clientIdinteger, (int64)

Zuora Revenue client ID.

createdBystring

User who created the hold.

createdDatestring, (date)

Creation date (yyyy-MM-dd).

updatedBystring

User who last updated the hold.

updatedDatestring, (date)

Last update date (yyyy-MM-dd).

property name*anyadditional property
Response
{
  "id": 20,
  "name": "Pending Acceptance",
  "description": "Hold revenue until customer acceptance is received",
  "startDate": "2026-01-01",
  "endDate": null,
  "eventId": 1003,
  "expiryFieldName": null,
  "expiryNumberType": null,
  "expiryDuration": null,
  "flags": {
    "enabled": "Y",
    "allowManualRelease": "Y",
    "allowManualApply": "Y",
    "holdType": "Revenue Hold",
    "holdLevel": "RC",
    "scheduleType": "Both"
  },
  "createdPeriodId": 202601,
  "clientId": 1,
  "createdBy": "jsmith",
  "createdDate": "2026-01-05",
  "updatedBy": "jsmith",
  "updatedDate": "2026-02-10"
}