Query price units

Use when searching or listing price units (e.g. admin catalog). Returns a paginated list; supports filtering and sorting.

POST /prices/units/search

Query price units

cURL

curl --request POST \
  --url https://us.api.flexprice.io/v1/prices/units/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "end_time": "2023-11-07T05:31:56Z",
  "expand": "<string>",
  "filters": [
    {
      "field": "<string>",
      "value": {
        "array": [
          "<string>"
        ],
        "boolean": true,
        "date": "<string>",
        "number": 123,
        "string": "<string>"
      }
    }
  ],
  "limit": 500,
  "offset": 1,
  "price_unit_ids": [
    "<string>"
  ],
  "sort": [
    {
      "field": "<string>"
    }
  ],
  "start_time": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://us.api.flexprice.io/v1/prices/units/search"

payload = {
    "end_time": "2023-11-07T05:31:56Z",
    "expand": "<string>",
    "filters": [
        {
            "field": "<string>",
            "value": {
                "array": ["<string>"],
                "boolean": True,
                "date": "<string>",
                "number": 123,
                "string": "<string>"
            }
        }
    ],
    "limit": 500,
    "offset": 1,
    "price_unit_ids": ["<string>"],
    "sort": [{ "field": "<string>" }],
    "start_time": "2023-11-07T05:31:56Z"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    end_time: '2023-11-07T05:31:56Z',
    expand: '<string>',
    filters: [
      {
        field: '<string>',
        value: {
          array: ['<string>'],
          boolean: true,
          date: '<string>',
          number: 123,
          string: '<string>'
        }
      }
    ],
    limit: 500,
    offset: 1,
    price_unit_ids: ['<string>'],
    sort: [{field: '<string>'}],
    start_time: '2023-11-07T05:31:56Z'
  })
};

fetch('https://us.api.flexprice.io/v1/prices/units/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.api.flexprice.io/v1/prices/units/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'end_time' => '2023-11-07T05:31:56Z',
    'expand' => '<string>',
    'filters' => [
        [
                'field' => '<string>',
                'value' => [
                                'array' => [
                                                                '<string>'
                                ],
                                'boolean' => true,
                                'date' => '<string>',
                                'number' => 123,
                                'string' => '<string>'
                ]
        ]
    ],
    'limit' => 500,
    'offset' => 1,
    'price_unit_ids' => [
        '<string>'
    ],
    'sort' => [
        [
                'field' => '<string>'
        ]
    ],
    'start_time' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/prices/units/search"

	payload := strings.NewReader("{\n  \"end_time\": \"2023-11-07T05:31:56Z\",\n  \"expand\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": {\n        \"array\": [\n          \"<string>\"\n        ],\n        \"boolean\": true,\n        \"date\": \"<string>\",\n        \"number\": 123,\n        \"string\": \"<string>\"\n      }\n    }\n  ],\n  \"limit\": 500,\n  \"offset\": 1,\n  \"price_unit_ids\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"start_time\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://us.api.flexprice.io/v1/prices/units/search")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"end_time\": \"2023-11-07T05:31:56Z\",\n  \"expand\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": {\n        \"array\": [\n          \"<string>\"\n        ],\n        \"boolean\": true,\n        \"date\": \"<string>\",\n        \"number\": 123,\n        \"string\": \"<string>\"\n      }\n    }\n  ],\n  \"limit\": 500,\n  \"offset\": 1,\n  \"price_unit_ids\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"start_time\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/prices/units/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"end_time\": \"2023-11-07T05:31:56Z\",\n  \"expand\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": {\n        \"array\": [\n          \"<string>\"\n        ],\n        \"boolean\": true,\n        \"date\": \"<string>\",\n        \"number\": 123,\n        \"string\": \"<string>\"\n      }\n    }\n  ],\n  \"limit\": 500,\n  \"offset\": 1,\n  \"price_unit_ids\": [\n    \"<string>\"\n  ],\n  \"sort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"start_time\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "base_currency": "<string>",
      "code": "<string>",
      "conversion_rate": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "environment_id": "<string>",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "symbol": "<string>",
      "tenant_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

{
  "http_status_code": 123,
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

Authorizations

x-api-key · string · header · required

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

Body

application/json

Filter

end_time · string<date-time>

expand · string

filters · object[]

filters allows complex filtering based on multiple fields

Show child attributes

limit · integer

Required range: 1 <= x <= 1000

offset · integer

Required range: x >= 0

order · enum<string>

Available options: asc, desc

price_unit_ids · string[]

sort · object[]

Show child attributes

start_time · string<date-time>

status · enum<string>

Available options: published, deleted, archived

Response

200

application/json

OK

items · object[]

Show child attributes

pagination · object

Show child attributes