# Retrieve a ramp

Retrieve a Ramp object. You can use the query parameters to filter, expand, and sort the returned results.

Endpoint: GET /object-query/ramps/{key}
Version: 2026-02-20
Security: bearerAuth

## Header parameters:

  - `Idempotency-Key` (string)
    Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. 

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

  - `Accept-Encoding` (string)
    Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. 

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

  - `Content-Encoding` (string)
    Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

  - `Zuora-Track-Id` (string)
    A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

  - `Zuora-Entity-Ids` (string)
    An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

  - `Zuora-Org-Ids` (string)
    Comma separated IDs. If you have Zuora Multi-Org enabled, 
you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

## Path parameters:

  - `key` (string, required)
    ID or number of the ramp.

## Query parameters:

  - `pageSize` (integer)
    The maximum number of results to return in a single page. If the specified pageSize is less than 1 or greater than 99, Zuora will return a 400 error.

  - `cursor` (string)
    A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with next_page=W3sib3JkZXJ=, your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.

  - `sort[]` (array)
    A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. accountnumber.ASC) or descending (e.g. accountnumber.DESC). You cannot sort on properties in arrays. If the array-type properties are specified for the sort[] parameter, they are ignored.
Supported sortable fields: 
  - id
  - updateddate
  - orderId

  - `expand[]` (array)
    Allows you to expand responses by including related object information in a single call.

  - `filter[]` (array)
    A case-insensitive filter on the list.

Supported filterable fields: 
  - id
  - updateddate
  - orderId
  - {indexedcustomfield}: Use the format like customField__c to filter on custom fields.

  - `fields[]` (array)
    A case-insensitive query parameter that allows you to specify which fields are returned in the response.
    Example: "id,createddate"

  - `includeNullFields` (boolean)
    Specifies whether to include fields with the null value in the response.

- If set to true, all fields will be returned in the response, including those with the null value.
- If set to false, only fields with non-null values will be returned.

## Response 200 fields (application/json):

  - `id` (string)
    The unique identifier of the ramp.

  - `createdById` (string)
    The unique identifier of the user who created the ramp.

  - `createdDate` (string)
    The time that the ramp gets created in the system, in the
YYYY-MM-DD HH:MM:SS format.

  - `updatedById` (string)
    The unique identifier of the user who last updated the ramp.

  - `updatedDate` (string)
    The date and time when the ramp was last updated.

  - `name` (string)
    The name of the ramp.

  - `number` (string)
    The number of the ramp. It is automaticcally generated by the billing system.

  - `description` (string)
    The short description of the ramp.

  - `subscriptionNumbers` (string)
    The number of the subscription that is considered as part of the ramp deal.

  - `chargeNumbers` (string)
    The number of the rate plan charge. It can contain multiple charge numbers, separated by commas(,).

  - `orderId` (string)
    The unique identifier of the order.

  - `grossTcb` (number)
    The gross TCB value before discount charges are applied.

  - `grossTcv` (number)
    The gross TCV value before discount charges are applied.

  - `netTcb` (number)
    The net TCB value after discount charges are applied.

  - `netTcv` (number)
    The net TCV value after discount charges are applied.

  - `discountTcb` (number)
    The discount amount for the TCB.

  - `discountTcv` (number)
    The discount amount for the TCV.

  - `metricsProcessingStatus` (string)
    Status of the metrics processing.
    Enum: "Completed", "NotStarted"

## Response 500 fields (application/json):

  - `reasons` (array)
    The container of the error code and message. This field is available only if the success field is false.

  - `reasons.code` (integer)
    The error code of response.

  - `reasons.message` (string)
    The detail information of the error response

  - `requestId` (string)
    The unique identifier of the request.

## Response 4XX fields (application/json):

  - `reasons` (array)
    The container of the error code and message. This field is available only if the success field is false.

  - `reasons.code` (integer)
    The error code of response.

  - `reasons.message` (string)
    The detail information of the error response

  - `requestId` (string)
    The unique identifier of the request.