List variable consideration types for a line

Revenue API

List variable consideration types for a line

Request

Purpose

Returns the variable consideration (VC) types that can still be applied to a line: enabled types that are configured on the line's POB template and not already applied to the line.

When to use

Before applying variable consideration, to find a valid vcTypeId.

Behavior notes

Pass the lead line of the POB as rcLineId; other lines return an empty list. An unknown contract or line also returns an empty list. rcLineId is required; omitting it returns HTTP 500.

Security

bearerAuth

Path

rcIdinteger, (int64)required

Revenue contract ID.

Example:111442

Query

rcLineIdinteger, (int64)required

Revenue contract line ID (the POB lead line).

Example:rcLineId=85922

vcRuleTypestring

Only return types with this rule type: E estimate, A actuals, S set.

Enum:"E""A""S"

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/revenue-management/contracts/111442/vc-types?rcLineId=85922&vcRuleType=E' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-REV-BOOK-ID: 1' \
  -H 'Zuora-Request-Id: b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11'

Responses

Applicable variable consideration types, sorted by name. Empty when none apply.

Headers

traceIdstring

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

Bodyapplication/json

Array [

idinteger, (int32)

Variable consideration type ID. Pass it as vcTypeId to apply variable consideration.

valuestring

Variable consideration type name.

]

Response

[
  {
    "id": 1,
    "value": "Rebate"
  },
  {
    "id": 2,
    "value": "Volume Discount"
  }
]