# Retrieve a subscription

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


**Important**  
For sites where both [legacy and latest](/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format) product catalog versions are active, GET API requests return responses in a `compat` format by default. This format works with both latest and legacy Product Catalog.

**Override options:**

-   `chargebee-response-schema-type: items` → Return response in latest product catalog format only.
-   `chargebee-response-schema-type: plans_addons` → Return response in legacy product catalog format only.

Retrieves details of a subscription.

## Sample Request

#### cURL

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

#### .NET

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

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

Subscription subscription = result.Subscription;
Customer customer = result.Customer;
Card card = result.Card;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    subscriptionAction "github.com/chargebee/chargebee-go/v3/actions/subscription"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := subscriptionAction.Retrieve("__test__KyVnHhSBWkv9J2YH").Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Subscription := res.Subscription
        Customer := res.Customer
        Card := res.Card
    }
}
```

#### 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.SubscriptionRetrieveRequest{
    Id : "__test__KyVnHhSBWkv9J2YH",
}
  res, err := client.Subscription.Retrieve(req)
      if err != nil {
        fmt.Println(err)
    } else {
        Subscription := res.Subscription
        Customer := res.Customer
        Card := res.Card
    }
}
```

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

        Subscription subscription = result.subscription();
        Customer customer = result.customer();
        Card card = result.card();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.card.Card;
import com.chargebee.v4.models.customer.Customer;
import com.chargebee.v4.models.subscription.Subscription;
import com.chargebee.v4.models.subscription.params.SubscriptionRetrieveParams;
import com.chargebee.v4.models.subscription.responses.SubscriptionRetrieveResponse;

public class SubscriptionRetrieve {

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

        SubscriptionRetrieveResponse response = client.subscriptions().retrieve("__test__KyVnHhSBWkv9J2YH");

        Subscription subscription = response.getSubscription();
        Customer customer = response.getCustomer();
        Card card = response.getCard();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.subscription.retrieve("__test__KyVnHhSBWkv9J2YH");

    console.log(result);
    const subscription = result.subscription;
    const customer = result.customer;
    const card = result.card;
} 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->subscription()->retrieve("__test__KyVnHhSBWkv9J2YH");
$subscription = $result->subscription;
$customer = $result->customer;
$card = $result->card;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Subscription.retrieve("__test__KyVnHhSBWkv9J2YH")
subscription = response.subscription
customer = response.customer
card = response.card
```

#### Ruby

```ruby
require 'chargebee'

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

result = ChargeBee::Subscription.retrieve("__test__KyVnHhSBWkv9J2YH")

subscription = result.subscription
customer = result.customer
card = result.card
```

## Sample Response

```json
{
  "customer": {
    "allow_direct_debit": false,
    "auto_collection": "off",
    "card_status": "no_card",
    "created_at": 1517505683,
    "deleted": false,
    "excess_payments": 0,
    "id": "__test__KyVnHhSBWkv9J2YH",
    "net_term_days": 0,
    "object": "customer",
    "pii_cleared": "active",
    "preferred_currency_code": "USD",
    "promotional_credits": 0,
    "refundable_credits": 0,
    "resource_version": 1517505683000,
    "taxability": "taxable",
    "unbilled_charges": 0,
    "updated_at": 1517505683
  },
  "subscription": {
    "activated_at": 1517505683,
    "billing_period": 1,
    "billing_period_unit": "month",
    "created_at": 1517505683,
    "currency_code": "USD",
    "current_term_end": 1519924883,
    "current_term_start": 1517505683,
    "customer_id": "__test__KyVnHhSBWkv9J2YH",
    "deleted": false,
    "due_invoices_count": 1,
    "due_since": 1517505683,
    "has_scheduled_changes": false,
    "id": "__test__KyVnHhSBWkv9J2YH",
    "mrr": 0,
    "next_billing_at": 1519924883,
    "object": "subscription",
    "plan_amount": 895,
    "plan_free_quantity": 0,
    "plan_id": "no_trial",
    "plan_quantity": 1,
    "plan_unit_price": 895,
    "resource_version": 1517505683000,
    "started_at": 1517505683,
    "status": "active",
    "total_dues": 895,
    "updated_at": 1517505683
  }
}
```

## URL Format

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

## Returns

- `subscription` (Subscription object)
  Resource object representing subscription

- `customer` (Customer object)
  Resource object representing customer

- `card` (Card object)
  Resource object representing card