# Retrieve a subscription ramp

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


Retrieves a specific subscription ramp.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/ramps/__test__rHsiT4rY2hC1A \
     -u {site_api_key}:
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = Ramp.Retrieve("__test__rHsiT4rY2hC1A").Request();

Ramp ramp = result.Ramp;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    rampAction "github.com/chargebee/chargebee-go/v3/actions/ramp"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := rampAction.Retrieve("__test__rHsiT4rY2hC1A").Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Ramp := res.Ramp
    }
}
```

#### 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)
  
  res, err := client.Ramp.Retrieve("__test__rHsiT4rY2hC1A")
      if err != nil {
        fmt.Println(err)
    } else {
        Ramp := res.Ramp
    }
}
```

#### 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 = Ramp.retrieve("__test__rHsiT4rY2hC1A").request();

        Ramp ramp = result.ramp();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.ramp.Ramp;
import com.chargebee.v4.models.ramp.params.RampRetrieveParams;
import com.chargebee.v4.models.ramp.responses.RampRetrieveResponse;

public class RampRetrieve {

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

        RampRetrieveResponse response = client.ramps().retrieve("__test__rHsiT4rY2hC1A");

        Ramp ramp = response.getRamp();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.ramp.retrieve("__test__rHsiT4rY2hC1A");

    console.log(result);
    const ramp = result.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->ramp()->retrieve("__test__rHsiT4rY2hC1A");
$ramp = $result->ramp;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Ramp.retrieve("__test__rHsiT4rY2hC1A")
ramp = response.ramp
```

#### Ruby

```ruby
require 'chargebee'

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

result = ChargeBee::Ramp.retrieve("__test__rHsiT4rY2hC1A")

ramp = result.ramp
```

## Sample Response

```json
{
  "ramp": {
    "id": "__test__rHsiT4rY2hC1A",
    "effective_from": "1635054328",
    "subscription_id": "__test__8asukSOXdv6kOj",
    "status": "scheduled",
    "description": "Schedule for first ramp",
    "created_at": "1635054328",
    "deleted": false,
    "updated_at": "1635054328",
    "items_to_remove": [
      "basicAddon1-USD-Monthly",
      {..}
    ],
    "items_to_add": [
      {
        "item_price_id": "basicAddon2-USD-Monthly",
        "quantity": 2
      },
      {..}
    ],
    "discounts_to_add": [
      {
        "duration_type": "one_time",
        "apply_on": "invoice_amount",
        "percentage": 5
      },
      {..}
    ],
    "items_to_update": [
      {
        "item_price_id": "basicPlan-USD-Monthly",
        "unit_price": 20000
      },
      {..}
    ],
    "contract_term": {
      "cancellation_cutoff_period": 7,
      "renewal_billing_cycles": 12,
      "action_at_term_end": "renew"
    }
  }
}
```

## URL Format

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

## Returns

- `ramp` (Ramp object)
  Resource object representing ramp