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

# List ramp metrics by subscription key

`GET /v1/subscriptions/{subscriptionKey}/ramp-metrics`

**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 key ramp metrics about a specified subscription, including the following metrics:

* TCB, TCV in the Ramp level
* TCB, TCV in the Interval level
* TCB, TCV, Quantity, and MRR in Interval Metrics
* Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta Metrics

See [Key metrics for Ramps](https://docs.zuora.com?resourceId=billing-key-metrics-of-ramps) for more information.

## 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

- GETRampMetricsBySubscriptionKeyResponseType
  - `rampMetrics` RampMetrics
    - `description` string — The short description of the ramp.
    - `discountTcb` number — The discount amount for the TCB.
    - `discountTcv` number — The discount amount for the TCV.
    - `grossTcb` number — The gross TCB value before discount charges are applied.
    - `grossTcv` number — The gross TCV value before discount charges are applied.
    - `intervals` RampIntervalMetrics[] — Container for the intervals that the ramp is split into in its timeline.
      - `description` string — The short description of the interval.
      - `discountTcb` number — The discount amount for the TCB.
      - `discountTcv` number — The discount amount for the TCV.
      - `endDate` string, date — The end date of the interval.
      - `grossTcb` number — The gross TCB value before discount charges are applied.
      - `grossTcv` number — The gross TCV value before discount charges are applied.
      - `intervalMetrics` RampIntervalChargeMetrics[] — Container for the detailed metrics for each rate plan charge in each ramp interval.
        - `chargeNumber` string — The number of the charge.
        - `discountTcb` number — The discount amount for the TCB.
        - `discountTcv` number — The discount amount for the TCV.
        - `endDate` string, date — The end date of the rate plan charge in the current ramp interval.
        - `grossTcb` number — The gross TCB value before discount charges are applied.
        - `grossTcv` number — The gross TCV value before discount charges are applied.
        - `mrr` object[] — The MRR changing history of the current rate plan charge in the current ramp interval.
          - `discount` number — The discount amount for the MRR.
          - `endDate` string, date — The end date.
          - `gross` number — The gross MRR amount before discounts charges are applied.
          - `net` number — The net MRR amount after discounts charges are applied.
          - `startDate` string, date — The start date.
        - `netTcb` number — The net TCB value after discount charges are applied.
        - `netTcv` number — The net TCV value after discount charges are applied.
        - `productRatePlanChargeId` string — The ID of the corresponding product rate plan charge.
        - `quantity` number — The quantity of the rate plan charge.
        - `ratePlanChargeId` string — The ID of the rate plan charge.
        - `startDate` string, date — The start date of the rate plan charge in the current ramp interval.
        - `subscriptionNumber` string — The number of the subscription that the current rate plan charge belongs to.
      - `name` string — The name of the interval.
      - `netTcb` number — The net TCB value after discount charges are applied.
      - `netTcv` number — The net TCV value after discount charges are applied.
      - `startDate` string, date — The start date of the interval.
    - `name` string — The name of the ramp.
    - `netTcb` number — The net TCB value after discount charges are applied.
    - `netTcv` number — The net TCV value after discount charges are applied.
    - `number` string — The number of the ramp. It is automaticcally generated by the billing system.
  - `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)