Get subscription entitlements

Use when checking what features or limits a subscription has (e.g. entitlement checks or feature gating). Optional feature_ids to filter.

GET /subscriptions/{id}/entitlements

Get subscription entitlements

cURL

curl --request GET \
  --url https://us.api.flexprice.io/v1/subscriptions/{id}/entitlements \
  --header 'x-api-key: <api-key>'

import requests

url = "https://us.api.flexprice.io/v1/subscriptions/{id}/entitlements"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://us.api.flexprice.io/v1/subscriptions/{id}/entitlements', 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/subscriptions/{id}/entitlements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/subscriptions/{id}/entitlements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://us.api.flexprice.io/v1/subscriptions/{id}/entitlements")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/subscriptions/{id}/entitlements")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

200

{
  "features": [
    {
      "entitlement": {
        "config_values": [
          {}
        ],
        "is_enabled": true,
        "is_soft_limit": true,
        "static_values": [
          "<string>"
        ],
        "usage_limit": 123
      },
      "feature": {
        "alert_settings": {
          "alert_enabled": true,
          "critical": {
            "threshold": "<string>"
          },
          "info": {
            "threshold": "<string>"
          },
          "warning": {
            "threshold": "<string>"
          }
        },
        "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>"
      },
      "sources": [
        {
          "config_value": {},
          "entitlement_id": "<string>",
          "entity_id": "<string>",
          "entity_name": "<string>",
          "is_enabled": true,
          "quantity": 123,
          "static_value": "<string>",
          "subscription_id": "<string>",
          "usage_limit": 123
        }
      ]
    }
  ],
  "plan_id": "<string>",
  "subscription_id": "<string>"
}

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

{
  "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>*

Path Parameters

id · string · required

Subscription ID

Query Parameters

feature_ids · string[]

Feature IDs to filter by

Response

200

application/json

OK

features · object[]

Show child attributes

plan_id · string

subscription_id · string