Skip to main content
POST
/
prices
/
units
Create price unit
curl --request POST \
  --url https://us.api.flexprice.io/v1/prices/units \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "base_currency": "<string>",
  "code": "<string>",
  "conversion_rate": "<string>",
  "name": "<string>",
  "symbol": "<string>",
  "metadata": {}
}
'
{
  "base_currency": "<string>",
  "code": "<string>",
  "conversion_rate": "<string>",
  "created_at": "<string>",
  "created_by": "<string>",
  "environment_id": "<string>",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "status": "published",
  "symbol": "<string>",
  "tenant_id": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Price unit details

​
base_currency
string
required

base_currency is the currency that the price unit is based on

​
code
string
required
​
conversion_rate
string
required

ConversionRate defines the exchange rate from this price unit to the base currency. This rate is used to convert amounts in the custom price unit to the base currency for storage and billing.

Conversion formula: price_unit_amount * conversion_rate = base_currency_amount

Example: If conversion_rate = "0.01" and base_currency = "usd": 100 price_unit tokens * 0.01 = 1.00 USD

Note: Rounding precision is determined by the base currency (e.g., USD uses 2 decimal places, JPY uses 0).

​
name
string
required
​
symbol
string
required
​
metadata
object

Response

Created

​
base_currency
string
​
code
string
​
conversion_rate
string
​
created_at
string
​
created_by
string
​
environment_id
string
​
id
string
​
metadata
object
​
name
string
​
status
enum<string>
Available options:
published,
deleted,
archived
​
symbol
string
​
tenant_id
string
​
updated_at
string
​
updated_by
string