Currencies

Represents a type of currency by which a financial operation is declared. This object is used by the Subscriptions, Billing, Payments APIs and the Purchases application.

Currency object

Attributes

Attributes

id string Unique object's identifier.

conversion string Another currency ID that determines the currency to which the amount of a billing or payment transaction should be converted.

country string The country to which the currency belongs. Learn more about countries

default boolean Determines if it is the primary currency of the country to which it belongs.

is_chargeable boolean Determines if the currency is chargeable by any of the available payment gateways.

name string Name of the currency.

rounded string Determines if the value of a currency related transaction should be rounded.

Currency object

{
    "id": "USD",
    "conversion": null,
    "name": "Dólar Estadounidense",
    "name_en": "American Dollar",
    "default": true,
    "is_chargeable": true,
    "available": true,
    "rounded": false,
    "country": "US"
}

See the complete list of currencies available in Piriod

List currencies

GET https://api.piriod.com/generals/currencies/

Lists currency objects. Learn more about pagination and filtering.

Query Parameters

Name	Type	Description
country	string	ID string of a particular country or multiple countries (using __in filter operator)
name	string	Exact or snippet of the currency name (using __exact, __contains or __icontains operators)

200 A list of currencies.

{
  "count": 26,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "PLN",
      "conversion": null,
      "name": "Zloty polaco",
      "name_en": "Polish złoty",
      "default": true,
      "is_chargeable": true,
      "available": false,
      "rounded": false,
      "country": "PL"
    },
    ...
    ...
    ...
    {
      "id": "JPY",
      "conversion": null,
      "name": "Yen japones",
      "name_en": "Japanese yen",
      "default": true,
      "is_chargeable": true,
      "available": false,
      "rounded": true,
      "country": "JP"
    }
  ]
}