---
title: "Retrieve a ramp"
method: GET
path: "/object-query/ramps/{key}"
tags: ["Object Queries"]
---

# Retrieve a ramp

`GET /object-query/ramps/{key}`

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

## Path parameters

- `key` string, required

## Query parameters

- `pageSize` integer
- `cursor` string
- `sort[]` string[]
- `expand[]` string[]
- `filter[]` string[]
- `fields[]` string[]
- `includeNullFields` boolean

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string

## Response `200`

OK

- ExpandedRamp
  - `id` string — The unique identifier of the ramp.
  - `createdById` string — The unique identifier of the user who created the ramp.
  - `createdDate` string, date-time — 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, date-time — 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` 'Completed' | 'NotStarted' — Status of the metrics processing.

## Other responses

- `500` — Internal server error
- `4XX` — Invalid input

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)