Skip to main content
POST
/
v1
/
plan-versions
/
list
list all plan versions
curl --request POST \
  --url https://api.unprice.dev/v1/plan-versions/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "onlyPublished": true,
  "onlyEnterprisePlan": false,
  "onlyLatest": true,
  "planVersionIds": [
    "pv_123"
  ],
  "billingInterval": "month",
  "currency": "USD"
}
'
import requests

url = "https://api.unprice.dev/v1/plan-versions/list"

payload = {
    "onlyPublished": True,
    "onlyEnterprisePlan": False,
    "onlyLatest": True,
    "planVersionIds": ["pv_123"],
    "billingInterval": "month",
    "currency": "USD"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    onlyPublished: true,
    onlyEnterprisePlan: false,
    onlyLatest: true,
    planVersionIds: ['pv_123'],
    billingInterval: 'month',
    currency: 'USD'
  })
};

fetch('https://api.unprice.dev/v1/plan-versions/list', 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://api.unprice.dev/v1/plan-versions/list",
  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([
    'onlyPublished' => true,
    'onlyEnterprisePlan' => false,
    'onlyLatest' => true,
    'planVersionIds' => [
        'pv_123'
    ],
    'billingInterval' => 'month',
    'currency' => 'USD'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.unprice.dev/v1/plan-versions/list"

	payload := strings.NewReader("{\n  \"onlyPublished\": true,\n  \"onlyEnterprisePlan\": false,\n  \"onlyLatest\": true,\n  \"planVersionIds\": [\n    \"pv_123\"\n  ],\n  \"billingInterval\": \"month\",\n  \"currency\": \"USD\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.unprice.dev/v1/plan-versions/list")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"onlyPublished\": true,\n  \"onlyEnterprisePlan\": false,\n  \"onlyLatest\": true,\n  \"planVersionIds\": [\n    \"pv_123\"\n  ],\n  \"billingInterval\": \"month\",\n  \"currency\": \"USD\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.unprice.dev/v1/plan-versions/list")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"onlyPublished\": true,\n  \"onlyEnterprisePlan\": false,\n  \"onlyLatest\": true,\n  \"planVersionIds\": [\n    \"pv_123\"\n  ],\n  \"billingInterval\": \"month\",\n  \"currency\": \"USD\"\n}"

response = http.request(request)
puts response.read_body
{
  "planVersions": [
    {
      "id": "<string>",
      "projectId": "<string>",
      "createdAtM": 123,
      "updatedAtM": 123,
      "planId": "<string>",
      "description": "<string>",
      "latest": true,
      "title": "<string>",
      "tags": [
        "<string>"
      ],
      "active": true,
      "publishedAt": 123,
      "publishedBy": "<string>",
      "archived": true,
      "archivedAt": 123,
      "archivedBy": "<string>",
      "billingConfig": {
        "name": "<string>",
        "billingIntervalCount": 30,
        "billingAnchor": 16
      },
      "gracePeriod": 123,
      "trialUnits": 123,
      "autoRenew": true,
      "metadata": {
        "externalId": "<string>"
      },
      "paymentMethodRequired": true,
      "version": 123,
      "plan": {
        "id": "<string>",
        "projectId": "<string>",
        "createdAtM": 123,
        "updatedAtM": 123,
        "slug": "<string>",
        "title": "<string>",
        "active": true,
        "description": "<string>",
        "metadata": {
          "externalId": "<string>"
        },
        "defaultPlan": true,
        "enterprisePlan": true
      },
      "planFeatures": [
        {
          "id": "<string>",
          "projectId": "<string>",
          "createdAtM": 123,
          "updatedAtM": 123,
          "planVersionId": "<string>",
          "featureId": "<string>",
          "unitOfMeasure": "<string>",
          "config": {
            "price": {
              "dinero": {
                "amount": 123,
                "currency": {
                  "code": "<string>",
                  "base": 123,
                  "exponent": 123
                },
                "scale": 123
              },
              "displayAmount": "<string>"
            },
            "tiers": [
              {
                "unitPrice": {
                  "dinero": {
                    "amount": 123,
                    "currency": {
                      "code": "<string>",
                      "base": 123,
                      "exponent": 123
                    },
                    "scale": 123
                  },
                  "displayAmount": "<string>"
                },
                "flatPrice": {
                  "dinero": {
                    "amount": 123,
                    "currency": {
                      "code": "<string>",
                      "base": 123,
                      "exponent": 123
                    },
                    "scale": 123
                  },
                  "displayAmount": "<string>"
                },
                "firstUnit": 2,
                "lastUnit": 2,
                "label": "<string>"
              }
            ],
            "units": 2
          },
          "billingConfig": {
            "name": "<string>",
            "billingIntervalCount": 30,
            "billingAnchor": 16
          },
          "metadata": {
            "realtime": false,
            "notifyUsageThreshold": 95,
            "overageStrategy": "none",
            "blockCustomer": false,
            "hidden": false,
            "billingCadenceOverride": true,
            "resetCadenceOverride": true
          },
          "order": 123,
          "displayFeatureText": "<string>",
          "feature": {
            "id": "<string>",
            "projectId": "<string>",
            "createdAtM": 123,
            "updatedAtM": 123,
            "slug": "<string>",
            "code": 123,
            "unitOfMeasure": "<string>",
            "title": "<string>",
            "description": "<string>",
            "meterConfig": {
              "eventId": "<string>",
              "eventSlug": "<string>",
              "aggregationField": "<string>",
              "filters": {},
              "groupBy": [
                "<string>"
              ]
            }
          },
          "resetConfig": {
            "name": "<string>",
            "resetIntervalCount": 30,
            "resetAnchor": 16
          },
          "defaultQuantity": 1,
          "limit": 123,
          "meterConfig": {
            "eventId": "<string>",
            "eventSlug": "<string>",
            "aggregationField": "<string>",
            "filters": {},
            "groupBy": [
              "<string>"
            ]
          }
        }
      ],
      "flatPrice": "<string>"
    }
  ]
}
{
  "error": {
    "code": "BAD_REQUEST",
    "docs": "https://docs.unprice.dev/api-reference/errors/code/BAD_REQUEST",
    "message": "<string>",
    "requestId": "req_1234"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "docs": "https://docs.unprice.dev/api-reference/errors/code/UNAUTHORIZED",
    "message": "<string>",
    "requestId": "req_1234"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "docs": "https://docs.unprice.dev/api-reference/errors/code/FORBIDDEN",
    "message": "<string>",
    "requestId": "req_1234"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "docs": "https://docs.unprice.dev/api-reference/errors/code/NOT_FOUND",
    "message": "<string>",
    "requestId": "req_1234"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "docs": "https://docs.unprice.dev/api-reference/errors/code/CONFLICT",
    "message": "<string>",
    "requestId": "req_1234"
  }
}
{
  "error": {
    "code": "PRECONDITION_FAILED",
    "docs": "https://docs.unprice.dev/api-reference/errors/code/PRECONDITION_FAILED",
    "message": "<string>",
    "requestId": "req_1234"
  }
}
{
  "error": {
    "code": "TOO_MANY_REQUESTS",
    "docs": "https://docs.unprice.dev/api-reference/errors/code/TOO_MANY_REQUESTS",
    "message": "<string>",
    "requestId": "req_1234"
  }
}
{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "docs": "https://docs.unprice.dev/api-reference/errors/code/INTERNAL_SERVER_ERROR",
    "message": "<string>",
    "requestId": "req_1234"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Body of the request

Query parameters for filtering and listing plan versions

​
onlyPublished
boolean

Whether to include published plan versions

Example:

true

​
onlyEnterprisePlan
boolean

Whether to include enterprise plan versions

Example:

false

​
onlyLatest
boolean

Whether to include the latest plan version

Example:

true

​
planVersionIds
string[]

Filter by plan version IDs

Example:
["pv_123"]
​
billingInterval
enum<string>

The billing interval to filter the plan versions

Available options:
month,
year,
week,
day,
minute,
onetime
Example:

"month"

​
currency
enum<string>

The currency to filter the plan versions

Available options:
USD,
EUR
Example:

"USD"

Response

The result of the list plan versions

​
planVersions
object[]
required