Skip to main content
POST
/
plans
/
search
Query plans
curl --request POST \
  --url https://us.api.flexprice.io/v1/plans/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,
  "lookup_key": "<string>",
  "metadata": {},
  "offset": 1,
  "plan_ids": [
    "<string>"
  ],
  "sort": [
    {
      "field": "<string>"
    }
  ],
  "start_time": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://us.api.flexprice.io/v1/plans/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,
    "lookup_key": "<string>",
    "metadata": {},
    "offset": 1,
    "plan_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,
    lookup_key: '<string>',
    metadata: {},
    offset: 1,
    plan_ids: ['<string>'],
    sort: [{field: '<string>'}],
    start_time: '2023-11-07T05:31:56Z'
  })
};

fetch('https://us.api.flexprice.io/v1/plans/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/plans/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,
    'lookup_key' => '<string>',
    'metadata' => [
        
    ],
    'offset' => 1,
    'plan_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/plans/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  \"lookup_key\": \"<string>\",\n  \"metadata\": {},\n  \"offset\": 1,\n  \"plan_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/plans/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  \"lookup_key\": \"<string>\",\n  \"metadata\": {},\n  \"offset\": 1,\n  \"plan_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/plans/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  \"lookup_key\": \"<string>\",\n  \"metadata\": {},\n  \"offset\": 1,\n  \"plan_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
{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "credit_grants": [
        {
          "conversion_rate": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "credit_grant_anchor": "2023-11-07T05:31:56Z",
          "credits": "<string>",
          "end_date": "2023-11-07T05:31:56Z",
          "environment_id": "<string>",
          "expiration_duration": 123,
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "period_count": 123,
          "plan_id": "<string>",
          "priority": 123,
          "start_date": "2023-11-07T05:31:56Z",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "topup_conversion_rate": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "description": "<string>",
      "display_order": 123,
      "entitlements": [
        {
          "addon": {
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "description": "<string>",
            "entitlements": "<array>",
            "environment_id": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "name": "<string>",
            "prices": [
              {
                "addon": "<unknown>",
                "amount": "<string>",
                "billing_cadence": "RECURRING",
                "billing_period_count": 123,
                "conversion_rate": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "created_by": "<string>",
                "currency": "<string>",
                "description": "<string>",
                "display_amount": "<string>",
                "display_name": "<string>",
                "display_price_unit_amount": "<string>",
                "end_date": "2023-11-07T05:31:56Z",
                "entity_id": "<string>",
                "environment_id": "<string>",
                "group": {
                  "created_at": "2023-11-07T05:31:56Z",
                  "entity_ids": [
                    "<string>"
                  ],
                  "entity_type": "<string>",
                  "id": "<string>",
                  "lookup_key": "<string>",
                  "metadata": {},
                  "name": "<string>",
                  "status": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z"
                },
                "group_id": "<string>",
                "id": "<string>",
                "lookup_key": "<string>",
                "metadata": {},
                "meter": {
                  "aggregation": {
                    "expression": "<string>",
                    "field": "<string>",
                    "group_by": "<string>",
                    "multiplier": "<string>"
                  },
                  "created_at": "2024-03-20T15:04:05Z",
                  "event_name": "api_request",
                  "filters": [
                    {
                      "key": "<string>",
                      "values": [
                        "<string>"
                      ]
                    }
                  ],
                  "id": "550e8400-e29b-41d4-a716-446655440000",
                  "name": "API Usage Meter",
                  "status": "published",
                  "tenant_id": "tenant123",
                  "updated_at": "2024-03-20T15:04:05Z"
                },
                "meter_id": "<string>",
                "min_quantity": "<string>",
                "parent_price_id": "<string>",
                "plan": "<unknown>",
                "price_unit": "<string>",
                "price_unit_amount": "<string>",
                "price_unit_id": "<string>",
                "price_unit_tiers": [
                  {
                    "flat_amount": "<string>",
                    "unit_amount": "<string>",
                    "up_to": 123
                  }
                ],
                "pricing_unit": {
                  "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>"
                },
                "sequence": 123,
                "start_date": "2023-11-07T05:31:56Z",
                "tenant_id": "<string>",
                "tiers": [
                  {
                    "flat_amount": "<string>",
                    "unit_amount": "<string>",
                    "up_to": 123
                  }
                ],
                "transform_quantity": {
                  "divide_by": 123
                },
                "trial_period_days": 123,
                "updated_at": "2023-11-07T05:31:56Z",
                "updated_by": "<string>"
              }
            ],
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "config_value": {},
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "display_order": 123,
          "end_date": "2023-11-07T05:31:56Z",
          "entity_id": "<string>",
          "environment_id": "<string>",
          "feature": {
            "alert_settings": {
              "alert_enabled": true,
              "critical": {
                "threshold": 123
              },
              "info": {
                "threshold": 123
              },
              "warning": {
                "threshold": 123
              }
            },
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "description": "<string>",
            "environment_id": "<string>",
            "group": {
              "created_at": "2023-11-07T05:31:56Z",
              "entity_ids": [
                "<string>"
              ],
              "entity_type": "<string>",
              "id": "<string>",
              "lookup_key": "<string>",
              "metadata": {},
              "name": "<string>",
              "status": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "group_id": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "meter": {
              "aggregation": {
                "expression": "<string>",
                "field": "<string>",
                "group_by": "<string>",
                "multiplier": "<string>"
              },
              "created_at": "2024-03-20T15:04:05Z",
              "event_name": "api_request",
              "filters": [
                {
                  "key": "<string>",
                  "values": [
                    "<string>"
                  ]
                }
              ],
              "id": "550e8400-e29b-41d4-a716-446655440000",
              "name": "API Usage Meter",
              "status": "published",
              "tenant_id": "tenant123",
              "updated_at": "2024-03-20T15:04:05Z"
            },
            "meter_id": "<string>",
            "name": "<string>",
            "reporting_unit": {
              "conversion_rate": 123,
              "unit_plural": "<string>",
              "unit_singular": "<string>"
            },
            "tenant_id": "<string>",
            "unit_plural": "<string>",
            "unit_singular": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "feature_id": "<string>",
          "id": "<string>",
          "is_enabled": true,
          "is_soft_limit": true,
          "parent_entitlement_id": "<string>",
          "plan": "<unknown>",
          "plan_id": "<string>",
          "start_date": "2023-11-07T05:31:56Z",
          "static_value": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>",
          "usage_limit": 123
        }
      ],
      "environment_id": "<string>",
      "id": "<string>",
      "lookup_key": "<string>",
      "metadata": {},
      "name": "<string>",
      "prices": [
        {
          "addon": "<unknown>",
          "amount": "<string>",
          "billing_cadence": "RECURRING",
          "billing_period_count": 123,
          "conversion_rate": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "currency": "<string>",
          "description": "<string>",
          "display_amount": "<string>",
          "display_name": "<string>",
          "display_price_unit_amount": "<string>",
          "end_date": "2023-11-07T05:31:56Z",
          "entity_id": "<string>",
          "environment_id": "<string>",
          "group": {
            "created_at": "2023-11-07T05:31:56Z",
            "entity_ids": [
              "<string>"
            ],
            "entity_type": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "name": "<string>",
            "status": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "group_id": "<string>",
          "id": "<string>",
          "lookup_key": "<string>",
          "metadata": {},
          "meter": {
            "aggregation": {
              "expression": "<string>",
              "field": "<string>",
              "group_by": "<string>",
              "multiplier": "<string>"
            },
            "created_at": "2024-03-20T15:04:05Z",
            "event_name": "api_request",
            "filters": [
              {
                "key": "<string>",
                "values": [
                  "<string>"
                ]
              }
            ],
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "name": "API Usage Meter",
            "status": "published",
            "tenant_id": "tenant123",
            "updated_at": "2024-03-20T15:04:05Z"
          },
          "meter_id": "<string>",
          "min_quantity": "<string>",
          "parent_price_id": "<string>",
          "plan": "<unknown>",
          "price_unit": "<string>",
          "price_unit_amount": "<string>",
          "price_unit_id": "<string>",
          "price_unit_tiers": [
            {
              "flat_amount": "<string>",
              "unit_amount": "<string>",
              "up_to": 123
            }
          ],
          "pricing_unit": {
            "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>"
          },
          "sequence": 123,
          "start_date": "2023-11-07T05:31:56Z",
          "tenant_id": "<string>",
          "tiers": [
            {
              "flat_amount": "<string>",
              "unit_amount": "<string>",
              "up_to": 123
            }
          ],
          "transform_quantity": {
            "divide_by": 123
          },
          "trial_period_days": 123,
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<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

​
limit
integer
Required range: 1 <= x <= 1000
​
lookup_key
string
​
metadata
object
​
offset
integer
Required range: x >= 0
​
order
enum<string>
Available options:
asc,
desc
​
plan_ids
string[]
​
sort
object[]
​
start_time
string<date-time>
​
status
enum<string>
Available options:
published,
deleted,
archived

Response

OK

​
items
object[]
​
pagination
object