Introduction

As part of its initial setup of monetization, the Apigee Edge configuration team specifies currencies supported by your organization. It also specifies the default currency for your organization.

You can retrieve the currencies that your organization supports, add supported currencies, or delete supported currencies (if the currencies are not used by a developer or a rate plan).

Monetization automatically runs a daily job that obtains the exchange rate in U.S. dollars for each supported currency. By default, the job runs every day at 1 second past midnght. You can change the schedule for the job or disable it. For details, see Schedule monetization jobs.

Toolbox

You can manage supported currencies using the management UI or monetization API. If you use the UI, you manage the supported currencies in the Tax and Currency section of the Organization Profile page.

If you use the API, you add supported currencies by issuing a POST request to the /organizations/{org_name}/supported-currencies resource. You retrieve, update, and delete a supported currency by making GET, PUT, and DELETE requests, respectively to the /organizations/{org_name}/supported-currencies/{currency_id} resource.

You can also change the default currency for the organization. Using the UI, you can set the default currency in the Tax and Currency section of the Organization Profile page. Using the API, you update the organization profile (see Editing the organization profile using the API for details). In the update, set the currency property to the name (that is, the ISO 4217 currency code) of the supported currency that you want to make the default.

Managing supported currencies using the UI

Retrieving supported currencies using the API

You can retrieve an individual currency supported by your organization or all the currencies supported by your organization.

To retrieve an individual currency supported by your organization, issue a GET request to /organizations/{org_name}/supported-currencies/{supportedCurrencyId}, where {supportedCurrency_id} is the identification of the supported currency to be retrieved. For example:

Updating a supported currency using the API

You can update a supported currency by issuing a PUT request to /organizations/{org_name}/{supportedCurrencyId}, where {supportedCurrency_id} is the identification of the supported currency to be updated. When you make the update, you need to specify in the request body the updated properties as well as the identification of the supported currency. For example, the following API call updates the description and display name for a supported currency (the updated properties are highlighted in the example):

Deleting a supported currency using the API

To delete a supported currency, issue a DELETE request to /organizations/{org_name}/supported-currencies/{currency_id}, where {currency_id} is the identification of the supported currency to be deleted. For example:

Next steps

Learn how to set up bank accounts for your organization in Add bank accounts. You only need to set up bank accounts if you plan to support postpaid developers, and you want monetization to generate billing documents.