OpenMeter Currencies

List currencies

Changed on

List currencies supported by the billing system.

get/openmeter/currencies

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/currencies
  • Auth: none declared

Query parameters

sizeinteger

The number of items to include per page.

numberinteger

The page number.

Determines which page of the collection to retrieve.

sortstring

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

Example:created_at desc

Sort currencies returned in the response. Supported sort attributes are:

  • code (default)
  • name

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order.

type'fiat' | 'custom'

Currency type for custom currencies. It should be a unique code but not conflicting with any existing standard currency codes.

Filter currencies returned in the response.

To filter currencies by type add the following query param: filter[type]=custom

expandBillingCurrencyExpand[]

Expand the currencies returned in the response.

To include the active and scheduled cost basis add: expand=cost_basis

Response

Page paginated response.

Example response

{
  "data": [
    {
      "code": "USD"
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes

  • v33adddc078e61Revision changes
    • info

      added the new optional query request parameter expand

  • v3e7222bb0aca6Revision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status