POST /currencies

This API is used to add a new currency to your Chargebee site. Prior to using this API, ensure that the multi-currency feature is enabled. If the forex_type is set to manual, you can specify the manual_exchange_rate. Additionally, the currency code provided must adhere to the three-letter ISO standard currency codes.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Valid values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Valid values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.
`chargebee-event-email`	String	No	skip only emails Valid values: `"all-disabled"`

Request body fields

Name Type Required Description

Name	Type	Required	Description
`forex_type`	String	Yes	This represents the exchange rate type set for the currency. 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 - 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 Valid values: `"manual"` `"auto"`
`currency_code`	String	Yes	A three letter currency code. For example, GBR, INR, and more.
`manual_exchange_rate`	String	No	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.

forex_type

String

Yes

This represents the exchange rate type set for the currency.

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 - 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

Valid values:

"manual"
"auto"

currency_code

String

Yes

A three letter currency code. For example, GBR, INR, and more.

manual_exchange_rate

String

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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.