---
title: "Retrieve a ramp by subscription key"
method: GET
path: "/v1/subscriptions/{subscriptionKey}/ramps"
tags: ["Ramps"]
---

# Retrieve a ramp by subscription key

`GET /v1/subscriptions/{subscriptionKey}/ramps`

**Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) feature must be enabled before you can access the [Ramps](https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information coming October 2020.

 Retrieves the definition of the ramp associated with a specified subscription.

## Path parameters

- `subscriptionKey` string, required

## Headers

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

## Response `200`

OK

- GETRampsBySubscriptionKeyResponseType
  - `ramps` RampResponse[]
    - `charges` RampChargeResponse[] — Container for the rate plan charges that are considered as part of the ramp deal.
      - `chargeNumber` string — The number of the rate plan charge.
    - `description` string — The short description of the ramp.
    - `id` string — The ID of the ramp.
    - `intervals` RampIntervalResponse[] — Container for the intervals that the ramp is split into in its timeline.
      - `description` string — The short description of the interval.
      - `endDate` string, date — The end date of the interval.
      - `name` string — The name of the interval.
      - `startDate` string, date — The start date of the interval.
    - `name` string — The name of the ramp.
    - `number` string — The number of the ramp. It is automaticcally generated by the billing system.
    - `subscriptionNumber` string — The number of the subscription that is considered as part of the ramp deal.
  - `processId` string — The ID of the process that handles the operation.
  - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`.
    - `code` string — The error code of response.
    - `message` string — The detail information of the error response
  - `requestId` string, uuid — Unique identifier of the request.
  - `success` boolean — Indicates whether the call succeeded.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[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)