Update a currency

Idempotency Supported

This API is used to update the configured currencies within your Chargebee site. Additionally, If the forex_type is set to manual , you can specify the manual_exchange_rate .

Prerequisites & Constraints

Multicurrency is not activated for your account yet. Enable the multi-currency feature before updating a currency.
manual_exchange_rate is required when forex_type is manual.

Sample Request

Sample Result[JSON]

URL Format

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

Input Parameters

forex_type

required, enumerated string

This represents the exchange rate type set for the currency.

Enum Values

manual

If forex_type is manual , you will be able to set the conversion rate for the currency. You need to update the exchange rate each time your exchange rate provider changes it

auto

If forex_type is auto , conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)

manual_exchange_rate

optional, 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.

Constraints

manual_exchange_rate must be a valid number greater than zero.
manual_exchange_rate has more than 9 decimal places; the server silently truncates to 9 decimals. Round the value yourself to avoid surprises.

Returns

currency

Currency object

Resource object representing currency