# Retrieve a promotional credit

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


This endpoint retrieves the promotional credit based on the promotional credit id

## Sample Request

#### cURL

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

#### .NET

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

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

PromotionalCredit promotionalCredit = result.PromotionalCredit;
```

#### Go

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

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

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

        PromotionalCredit promotionalCredit = result.promotionalCredit();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.promotionalCredit.PromotionalCredit;
import com.chargebee.v4.models.promotionalCredit.params.PromotionalCreditRetrieveParams;
import com.chargebee.v4.models.promotionalCredit.responses.PromotionalCreditRetrieveResponse;

public class PromotionalCreditRetrieve {

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

        PromotionalCreditRetrieveResponse response = client.promotionalCredits().retrieve("pc___test__KyVnHhSBWSuN257");

        PromotionalCredit promotionalCredit = response.getPromotionalCredit();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.promotionalCredit.retrieve("pc___test__KyVnHhSBWSuN257");

    console.log(result);
    const promotionalCredit = result.promotional_credit;
} 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->promotionalCredit()->retrieve("pc___test__KyVnHhSBWSuN257");
$promotionalCredit = $result->promotional_credit;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.PromotionalCredit.retrieve("pc___test__KyVnHhSBWSuN257")
promotional_credit = response.promotional_credit
```

#### Ruby

```ruby
require 'chargebee'

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

result = ChargeBee::PromotionalCredit.retrieve("pc___test__KyVnHhSBWSuN257")

promotional_credit = result.promotional_credit
```

## Sample Response

```json
{
  "promotional_credit": {
    "amount": 100,
    "closing_balance": 100,
    "created_at": 1517501390,
    "credit_type": "general",
    "currency_code": "USD",
    "customer_id": "__test__KyVnHhSBWSuLo55",
    "description": "set promotional credits",
    "done_by": "full_access_key_v1",
    "id": "pc___test__KyVnHhSBWSuN257",
    "object": "promotional_credit",
    "type": "increment"
  }
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/promotional_credits/{account-credit-id}

## Returns

- `promotional_credit` (Promotional credit object)
  Resource object representing promotional\_credit