Get Customer Entitlements

GET

customers

{id}

entitlements

Effective entitlements for a customer

curl --request GET \
  --url https://billing.example.com/v1/customers/{id}/entitlements \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/customers/{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://billing.example.com/v1/customers/{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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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://billing.example.com/v1/customers/{id}/entitlements"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/customers/{id}/entitlements")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "feature_key": "<string>",
      "kind": "boolean",
      "bool_value": true,
      "limit_value": 123,
      "plan_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

Resolves the customer’s effective entitlements as a union across the plans of every active and trialing subscription they hold:

boolean — any-true wins: granted if any contributing plan grants it
limit — max wins: the highest limit_value across contributing plans
A feature key that is boolean on one plan and limit on another resolves to limit

Subscriptions in any other state contribute nothing.

Example Request

curl https://api.recurso.dev/v1/customers/1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed/entitlements \
  -H "Authorization: Bearer $API_KEY"

Response

{
  "data": [
    {
      "feature_key": "api_calls_per_month",
      "kind": "limit",
      "bool_value": null,
      "limit_value": 100000,
      "plan_ids": ["8f14e45f-ceea-467f-a1d6-8f2f3f9a1b2c"]
    },
    {
      "feature_key": "seats",
      "kind": "limit",
      "bool_value": null,
      "limit_value": 25,
      "plan_ids": [
        "8f14e45f-ceea-467f-a1d6-8f2f3f9a1b2c",
        "6512bd43-d9ca-4e9c-9f3a-1a2b3c4d5e6f"
      ]
    },
    {
      "feature_key": "sso",
      "kind": "boolean",
      "bool_value": true,
      "limit_value": null,
      "plan_ids": ["6512bd43-d9ca-4e9c-9f3a-1a2b3c4d5e6f"]
    }
  ]
}

plan_ids lists every plan that contributed the feature, so you can show customers why they have an entitlement. A customer with no active or trialing subscriptions returns an empty data array; an unknown customer returns 404 with code not_found.

For per-request feature gating, prefer the single-query check endpoint over fetching the full set.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

string<uuid>

required

Response

Effective entitlement set with granting plan ids

data

object[]

Show child attributes

Effective entitlements for a customer

curl --request GET \
  --url https://billing.example.com/v1/customers/{id}/entitlements \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/customers/{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://billing.example.com/v1/customers/{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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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://billing.example.com/v1/customers/{id}/entitlements"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/customers/{id}/entitlements")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "feature_key": "<string>",
      "kind": "boolean",
      "bool_value": true,
      "limit_value": 123,
      "plan_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Get Customer Entitlements

Example Request

Response

Authorizations

Path Parameters

Response

​Example Request

​Response

Authorizations

Path Parameters

Response

Example Request

Response