Skip to main content
POST
/
v1
/
access
/
check
get current feature status
curl --request POST \
  --url https://api.unprice.dev/v1/access/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "cus_1H7KQFLr7RepUyQBKdnvY",
  "featureSlug": "tokens",
  "timestamp": 1774094400000
}
'
import requests

url = "https://api.unprice.dev/v1/access/check"

payload = {
"customerId": "cus_1H7KQFLr7RepUyQBKdnvY",
"featureSlug": "tokens",
"timestamp": 1774094400000
}
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({
customerId: 'cus_1H7KQFLr7RepUyQBKdnvY',
featureSlug: 'tokens',
timestamp: 1774094400000
})
};

fetch('https://api.unprice.dev/v1/access/check', 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/access/check",
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([
'customerId' => 'cus_1H7KQFLr7RepUyQBKdnvY',
'featureSlug' => 'tokens',
'timestamp' => 1774094400000
]),
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/access/check"

payload := strings.NewReader("{\n \"customerId\": \"cus_1H7KQFLr7RepUyQBKdnvY\",\n \"featureSlug\": \"tokens\",\n \"timestamp\": 1774094400000\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/access/check")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"cus_1H7KQFLr7RepUyQBKdnvY\",\n \"featureSlug\": \"tokens\",\n \"timestamp\": 1774094400000\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.unprice.dev/v1/access/check")

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 \"customerId\": \"cus_1H7KQFLr7RepUyQBKdnvY\",\n \"featureSlug\": \"tokens\",\n \"timestamp\": 1774094400000\n}"

response = http.request(request)
puts response.read_body
{
  "allowed": true,
  "featureSlug": "tokens",
  "rejectionReason": "LIMIT_EXCEEDED",
  "usage": 42,
  "limit": 100,
  "spending": {
    "ledgerAmount": 4200000000,
    "currency": "USD",
    "displayAmount": "$42",
    "scale": 8
  },
  "message": "Unable to resolve the current meter window for this feature"
}
{
"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

customerId
string
required

The unprice customer ID

Example:

"cus_1H7KQFLr7RepUyQBKdnvY"

featureSlug
string
required

The feature slug

Example:

"tokens"

timestamp
number

Optional timestamp to inspect a recent point-in-time state. Defaults to the request start time.

Example:

1774094400000

Response

The current feature verification status

allowed
boolean
required

Whether the feature is currently usable for the requested customer and timestamp

Example:

true

featureSlug
string
required

The feature slug that was verified

Example:

"tokens"

rejectionReason
enum<string>

Why the feature is not usable. Omitted when allowed is true.

Available options:
CUSTOMER_NOT_FOUND,
EVENT_TOO_OLD,
INVALID_ENTITLEMENT_CONFIGURATION,
INVALID_AGGREGATION_PROPERTIES,
LIMIT_EXCEEDED,
LATE_EVENT_CLOSED_PERIOD,
NO_MATCHING_ENTITLEMENT,
RUN_BUDGET_EXCEEDED,
UNROUTABLE_EVENT,
WALLET_EMPTY
Example:

"LIMIT_EXCEEDED"

usage
number

Current usage in the active meter window. Present for usage features.

Example:

42

limit
number | null

Configured limit. For usage features this is the active meter-window limit; for tier/package features this is the subscribed quantity limit.

Example:

100

spending
object

Current priced usage spend for usage-based features

message
string

Optional detail about the verification result

Example:

"Unable to resolve the current meter window for this feature"