# Add schedule

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


[Idempotency Supported](/docs/api/idempotency)

This API is used to schedule exchange rate modification for a `manual` `forex_type` currency.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/currencies/cur_XpbNwDtU56AzUh3j/add_schedule \
     -u {site_api_key}:\
     -d manual_exchange_rate="1.234784" \
     -d schedule_at=1608209339
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = Currency.AddSchedule("cur_XpbNwDtU56AzUh3j")
		.ManualExchangeRate("1.234784")
		.ScheduleAt(1608209339)
		.Request();

Currency currency = result.Currency;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    currencyAction "github.com/chargebee/chargebee-go/v3/actions/currency"
    "github.com/chargebee/chargebee-go/v3/models/currency"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := currencyAction.AddSchedule("cur_XpbNwDtU56AzUh3j", &currency.AddScheduleRequestParams{
        ManualExchangeRate : "1.234784",
        ScheduleAt : chargebee.Int64(1608209339),
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Currency := res.Currency
    }
}
```

#### 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.CurrencyAddScheduleRequest{
    ManualExchangeRate : "1.234784",
    ScheduleAt : chargebee.Int64(1608209339),
}
  res, err := client.Currency.AddSchedule("cur_XpbNwDtU56AzUh3j", req)
      if err != nil {
        fmt.Println(err)
    } else {
        Currency := res.Currency
    }
}
```

#### Java

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

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = Currency.addSchedule("cur_XpbNwDtU56AzUh3j")
            .manualExchangeRate("1.234784")
            .scheduleAt(new Timestamp(1608209339L * 1000))
            .request();

        Currency currency = result.currency();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.currency.Currency;
import com.chargebee.v4.models.currency.params.CurrencyAddScheduleParams;
import com.chargebee.v4.models.currency.responses.CurrencyAddScheduleResponse;
import java.sql.Timestamp;

public class CurrencyAddSchedule {

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

        CurrencyAddScheduleParams params = CurrencyAddScheduleParams.builder()
            .manualExchangeRate("1.234784")
            .scheduleAt(new Timestamp(1608209339L * 1000))
            .build();

        CurrencyAddScheduleResponse response = client
            .currencies()
            .addSchedule("cur_XpbNwDtU56AzUh3j", params);

        Currency currency = response.getCurrency();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.currency.addSchedule("cur_XpbNwDtU56AzUh3j", {
        manual_exchange_rate: "1.234784",
        schedule_at: 1608209339
    });

    console.log(result);
    const currency = result.currency;
} 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->currency()->addSchedule("cur_XpbNwDtU56AzUh3j", [
    "manual_exchange_rate" => "1.234784",
    "schedule_at" => 1608209339
]);
$currency = $result->currency;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Currency.add_schedule("cur_XpbNwDtU56AzUh3j",
    cb_client.Currency.AddScheduleParams(
        manual_exchange_rate="1.234784",
        schedule_at=1608209339
    )
)
currency = response.currency
```

#### Ruby

```ruby
require 'chargebee'

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

result = ChargeBee::Currency.add_schedule("cur_XpbNwDtU56AzUh3j",{
  :manual_exchange_rate => "1.234784",
  :schedule_at => 1608209339
})

currency = result.currency
```

## Sample Response

```json
{
  "scheduled_at": "1608209339",
  "currency": {
    "id": "cur_XpbNwDtU56AzUh3j",
    "currency_code": "EUR",
    "is_base_currency": false,
    "forex_type": "manual",
    "manual_exchange_rate": "1.234784"
  }
}
```

## URL Format

**POST** https://[site].chargebee.com/api/v2/currencies/{site-currency-id}/add_schedule

## Input Parameters

- `manual_exchange_rate` (required, string, max chars=20)
  This parameter allows you to pass the exchange rate in decimal format. When `forex_type` is `manual` you have to set the exchange rate for additional currencies in `manual_exchange_rate` parameter. A maximum of **nine** decimal values are allowed to pass in this field.

- `schedule_at` (required, timestamp(UTC) in seconds)
  Timestamp at which the exchange rate scheduled has to be updated in your site. This timestamp must be a future date.

## Returns

- `scheduled_at` (required, timestamp(UTC) in seconds)
  Timestamp at which the scheduled exchange rate is to be updated on your site.

- `currency` (Currency object)
  Resource object representing currency