# Retrieve a price ramp

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


Retrieves a price ramp using its unique ID, including its `status` and the ordered list of `ramp_intervals`.

### Prerequisites & Constraints

-   [Price Ramps](https://www.chargebee.com/docs/billing/2.0/product-catalog/price-ramps) must be enabled for the site. Contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support) to enable them. Until they are enabled, this operation returns `API_RESTRICTED`.

## Sample Request

#### Chargebee CLI

```bash
chargebee price-ramp retrieve 3b930dda-1444-44f1-b79b-8de01fd9c139
```

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/price_ramps/3b930dda-1444-44f1-b79b-8de01fd9c139 \
     -u {site_api_key}:
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = PriceRamp.Retrieve("3b930dda-1444-44f1-b79b-8de01fd9c139").Request();

PriceRamp priceRamp = result.PriceRamp;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    pricerampAction "github.com/chargebee/chargebee-go/v3/actions/priceramp"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := pricerampAction.Retrieve("3b930dda-1444-44f1-b79b-8de01fd9c139").Request()
    if err != nil {
        fmt.Println(err)
    } else {
        PriceRamp := res.PriceRamp
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.PriceRampRetrieveRequest{
    Id : "3b930dda-1444-44f1-b79b-8de01fd9c139",
}
  res, err := client.PriceRamp.Retrieve(req)
      if err != nil {
        fmt.Println(err)
    } else {
        PriceRamp := res.PriceRamp
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = PriceRamp.retrieve("3b930dda-1444-44f1-b79b-8de01fd9c139").request();

        PriceRamp priceRamp = result.priceRamp();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.priceRamp.PriceRamp;
import com.chargebee.v4.models.priceRamp.params.PriceRampRetrieveParams;
import com.chargebee.v4.models.priceRamp.responses.PriceRampRetrieveResponse;

public class PriceRampRetrieve {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        PriceRampRetrieveResponse response = client.priceRamps().retrieve("3b930dda-1444-44f1-b79b-8de01fd9c139");

        PriceRamp priceRamp = response.getPriceRamp();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.priceRamp.retrieve("3b930dda-1444-44f1-b79b-8de01fd9c139");

    console.log(result);
    const priceRamp = result.price_ramp;
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->priceRamp()->retrieve("3b930dda-1444-44f1-b79b-8de01fd9c139");
$priceRamp = $result->price_ramp;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.PriceRamp.retrieve("3b930dda-1444-44f1-b79b-8de01fd9c139")
price_ramp = response.price_ramp
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

result = ChargeBee::PriceRamp.retrieve("3b930dda-1444-44f1-b79b-8de01fd9c139")

price_ramp = result.price_ramp
```

## Sample Response

```json
{
  "price_ramp": {
    "id": "3b930dda-1444-44f1-b79b-8de01fd9c139",
    "item_price_id": "basic-USD-Monthly",
    "status": "active",
    "object": "price_ramp",
    "ramp_intervals": [
      {
        "starting_billing_cycle": 1,
        "ending_billing_cycle": 1,
        "price": 99
      },
      {
        "starting_billing_cycle": 2,
        "ending_billing_cycle": 4,
        "price": 499
      },
      {
        "starting_billing_cycle": 5,
        "apply_catalog_price": true,
        "price": 999
      }
    ],
    "resource_version": 1594110587730,
    "created_at": 1594110587,
    "updated_at": 1594110587
  }
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/price_ramps/{price-ramp-id}

## Returns

- `price_ramp` (Price ramp object)