Skip to content
Revenue API
/
/
Retrieve a revenue contra...

Retrieve a revenue contract line

Request

Purpose

Returns one line of a revenue contract.

When to use

  • Read the attributes of a specific line before or after you edit it.
  • Verify that a line belongs to the contract you expect.

Behavior notes

A line that exists but belongs to a different contract returns HTTP 404.

Security
bearerAuth
Path
rcIdinteger, (int64)required

Revenue contract ID.

Example:111442
lineIdinteger, (int64)required

Revenue contract line ID.

Example:85922
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
cURL
curl -i -X GET \
  https://one.zuora.com/revenue/services/v1/contracts/111442/lines/85922 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-REV-BOOK-ID: 1' \
  -H 'Zuora-Request-Id: b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11'

Responses

The revenue contract line.

Headers
traceIdstring

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

Bodyapplication/json
idinteger, (int64)required

Revenue contract line ID.

rcIdinteger, (int64)required

Revenue contract the line belongs to.

indicatorsobject(Indicators)

Status flags of the record. Each key is a flag name in camelCase and each value is a single-character code, usually Y or N. The set of keys depends on the record type and the Zuora Revenue release.

Example:
{
  "allocationEligible": "Y",
  "multiCurrency": "N"
}
stringAttributesobject

Custom text attributes atr1 to atr60.

numberAttributesobject

Custom number attributes num1 to num15.

dateAttributesobject

Custom date attributes date1 to date5 (yyyy-MM-dd).

rcLineOtrAttributesobject

Other line attributes.

property name*anyadditional property
Response
{
  "id": 85922,
  "rcId": 111442,
  "indicators": {
    "allocationEligible": "Y"
  },
  "stringAttributes": {
    "atr1": "EMEA",
    "atr2": null
  },
  "numberAttributes": {
    "num1": "12.50",
    "num2": null
  },
  "dateAttributes": {
    "date1": "2026-01-31",
    "date2": null
  },
  "rcLineOtrAttributes": {
    "rpcNum": "C-00012345"
  }
}