Skip to main content
POST
/
v1
/
access
/
entitlements
/
list
get customer entitlements
curl --request POST \
  --url https://api.unprice.dev/v1/access/entitlements/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "cus_1H7KQFLr7RepUyQBKdnvY",
  "projectId": "prj_1H7KQFLr7RepUyQBKdnvY"
}
'
import requests

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

payload = {
    "customerId": "cus_1H7KQFLr7RepUyQBKdnvY",
    "projectId": "prj_1H7KQFLr7RepUyQBKdnvY"
}
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',
    projectId: 'prj_1H7KQFLr7RepUyQBKdnvY'
  })
};

fetch('https://api.unprice.dev/v1/access/entitlements/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/access/entitlements/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([
    'customerId' => 'cus_1H7KQFLr7RepUyQBKdnvY',
    'projectId' => 'prj_1H7KQFLr7RepUyQBKdnvY'
  ]),
  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/entitlements/list"

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

url = URI("https://api.unprice.dev/v1/access/entitlements/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  \"customerId\": \"cus_1H7KQFLr7RepUyQBKdnvY\",\n  \"projectId\": \"prj_1H7KQFLr7RepUyQBKdnvY\"\n}"

response = http.request(request)
puts response.read_body
[
  {
    "id": "<string>",
    "projectId": "<string>",
    "createdAtM": 123,
    "updatedAtM": 123,
    "customerId": "<string>",
    "featurePlanVersionId": "<string>",
    "subscriptionId": "<string>",
    "subscriptionPhaseId": "<string>",
    "subscriptionItemId": "<string>",
    "effectiveAt": 123,
    "expiresAt": 123,
    "metadata": {},
    "featurePlanVersion": {
      "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,
      "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>"
        ]
      }
    },
    "grants": [
      {
        "id": "<string>",
        "projectId": "<string>",
        "createdAtM": 123,
        "updatedAtM": 123,
        "customerEntitlementId": "<string>",
        "priority": 123,
        "allowanceUnits": 1,
        "effectiveAt": 123,
        "expiresAt": 123,
        "metadata": {}
      }
    ],
    "subscriptionPhase": {}
  }
]
{
  "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 customer ID

Example:

"cus_1H7KQFLr7RepUyQBKdnvY"

projectId
string

The project ID

Example:

"prj_1H7KQFLr7RepUyQBKdnvY"

Response

The result of the get customer entitlements

id
string
required
Maximum string length: 36
projectId
string
required
Maximum string length: 36
createdAtM
number
required
updatedAtM
number
required
customerId
string
required
Maximum string length: 36
featurePlanVersionId
string
required
Maximum string length: 36
subscriptionId
string | null
required
Maximum string length: 36
subscriptionPhaseId
string | null
required
Maximum string length: 36
subscriptionItemId
string | null
required
Maximum string length: 36
effectiveAt
number
required
expiresAt
number | null
required
overageStrategy
enum<string>
required
Available options:
none,
last-call,
always
metadata
object | null
required
featurePlanVersion
object
required
grants
object[]
subscriptionPhase
object | null