Contents
On this page
List Currencies - Plugixa Multi Currency for WooCommerce
GET /plugixa-multi-currency/v1/currencies
Your currencies with their rates, margins, formatting and rounding, as the Currencies screen shows them. The store currency comes first, then the others in your order. See Currencies.
Needs a user with the plugixa_multi_currency_view capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Administrators hold it; see Capabilities.
Request
GET https://your-store.example/wp-json/plugixa-multi-currency/v1/currencies?search=euro
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
search |
string |
No | Part of a code or a name, any case, for example eur or dollar. |
orderby |
string |
No | code, name, rate, margin_pct, enabled or rate_updated_at. Leave it out for your own order. |
order |
string |
No | asc (default) or desc. |
page |
integer |
No | Page to return, from 1. Defaults to 1. |
per_page |
integer |
No | Currencies per page, 1 to 200. Defaults to 200. |
Responses
200 OK. data is the page of currencies.
{
"success": true,
"data": [
{
"id": 2,
"code": "EUR",
"enabled": true,
"sort": 20,
"symbol": "€",
"position": "right_space",
"decimals": 2,
"thousand_sep": ".",
"decimal_sep": ",",
"flag": "EU",
"in_switcher": true,
"rate": "0.9099181073",
"rate_source": "ecb",
"rate_locked": false,
"margin_pct": "1",
"margin_fixed": "0",
"rounding": {
"price": {
"step": "0",
"mode": "nearest"
},
"shipping": {
"step": "0",
"mode": "nearest"
},
"fee": {
"step": "0",
"mode": "nearest"
}
},
"checkout_mode": "selected",
"rate_updated_at": "2026-11-20 16:20:17",
"created_at": "2026-11-19 16:05:53",
"updated_at": "2026-11-20 16:20:17",
"name": "Euro",
"is_base": false
}
],
"meta": {
"total": 1,
"pages": 1,
"base": "USD"
}
}
| Field | Type | Meaning |
|---|---|---|
id |
integer |
The currency’s id. Routes with {code} accept it in place of the code |
code |
string |
The ISO 4217 code, for example EUR |
name |
string |
The name WooCommerce gives the code |
is_base |
boolean |
Whether this is your WooCommerce store currency |
enabled |
boolean |
Whether shoppers can use it |
in_switcher |
boolean |
Whether it is offered in the switchers |
sort |
integer |
Its place in the list. The store currency always comes first |
symbol |
string |
The symbol shown with prices, up to 16 characters |
position |
string |
Where the symbol goes: left, right, left_space or right_space |
decimals |
integer |
Decimals shown, 0 to 4 |
thousand_sep |
string |
Thousands separator |
decimal_sep |
string |
Decimal separator |
flag |
string |
Two-letter country code of the flag, empty for none |
rate |
string |
Units of this currency for 1 unit of the store currency. Always 1 for the store currency |
rate_source |
string |
Where the rate came from: manual, base, or a provider id such as ecb |
rate_locked |
boolean |
true keeps the rate out of automatic updates |
margin_pct |
string |
Percent added to the rate, -100 (excluded) to 1000 |
margin_fixed |
string |
Fixed amount added to each product price, in this currency |
rounding |
object |
One rule each for price, shipping and fee: step (0 for none, or for example 0.05, 1, 10) and mode (nearest, up or down) |
checkout_mode |
string |
selected charges in this currency, base shows prices in it but charges in the store currency |
rate_updated_at |
string |
When the rate last changed, UTC |
created_at |
string |
UTC |
updated_at |
string |
UTC |
meta.total |
integer |
Currencies matching the search |
meta.pages |
integer |
Number of pages |
meta.base |
string |
Your WooCommerce store currency |
Errors
| Status | Code | When |
|---|---|---|
401 / 403 |
plugixa_multi_currency_forbidden |
The caller lacks the capability. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-store.example/wp-json/plugixa-multi-currency/v1/currencies?search=euro" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-store.example/wp-json/plugixa-multi-currency/v1/currencies?search=euro');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-store.example/wp-json/plugixa-multi-currency/v1/currencies?search=euro', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share