# Retrieve a coupon code

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


Retrieves a specific coupon code details.

## Sample Request

#### cURL

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

#### .NET

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

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

CouponCode couponCode = result.CouponCode;
```

#### Go

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

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

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

        CouponCode couponCode = result.couponCode();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.couponCode.CouponCode;
import com.chargebee.v4.models.couponCode.params.CouponCodeRetrieveParams;
import com.chargebee.v4.models.couponCode.responses.CouponCodeRetrieveResponse;

public class CouponCodeRetrieve {

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

        CouponCodeRetrieveResponse response = client.couponCodes().retrieve("CBC978B");

        CouponCode couponCode = response.getCouponCode();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.couponCode.retrieve("CBC978B");

    console.log(result);
    const couponCode = result.coupon_code;
} 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->couponCode()->retrieve("CBC978B");
$couponCode = $result->coupon_code;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.CouponCode.retrieve("CBC978B")
coupon_code = response.coupon_code
```

#### Ruby

```ruby
require 'chargebee'

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

result = ChargeBee::CouponCode.retrieve("CBC978B")

coupon_code = result.coupon_code
```

## Sample Response

```json
{
  "coupon_code": {
    "code": "CBC978B",
    "coupon_id": "alpha",
    "coupon_set_id": "cs_3Rtysnm",
    "coupon_set_name": "Offer",
    "object": "coupon_code",
    "status": "not_redeemed"
  }
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/coupon_codes/{coupon-code-code}

## Returns

- `coupon_code` (Coupon code object)
  Resource object representing coupon\_code