import Stigg from '@stigg/typescript';
const client = new Stigg({
apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});
const response = await client.v1.customers.retrieveEntitlements('x');
console.log(response.data);import os
from stigg import Stigg
client = Stigg(
api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted
)
response = client.v1.customers.retrieve_entitlements(
id="x",
)
print(response.data)package main
import (
"context"
"fmt"
"github.com/stiggio/stigg-go"
"github.com/stiggio/stigg-go/option"
)
func main() {
client := stigg.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.V1.Customers.GetEntitlements(
context.TODO(),
"x",
stigg.V1CustomerGetEntitlementsParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}
package io.stigg.example;
import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.customers.CustomerRetrieveEntitlementsParams;
import io.stigg.models.v1.customers.CustomerRetrieveEntitlementsResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
StiggClient client = StiggOkHttpClient.fromEnv();
CustomerRetrieveEntitlementsResponse response = client.v1().customers().retrieveEntitlements("x");
}
}require "stigg"
stigg = Stigg::Client.new(api_key: "My API Key")
response = stigg.v1.customers.retrieve_entitlements("x")
puts(response)using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Customers;
StiggClient client = new();
CustomerRetrieveEntitlementsParams parameters = new() { ID = "x" };
var response = await client.V1.Customers.RetrieveEntitlements(parameters);
Console.WriteLine(response);stigg v1:customers retrieve-entitlements \
--api-key 'My API Key' \
--id xcurl --request GET \
--url https://api.stigg.io/api/v1/customers/{id}/entitlements \
--header 'X-API-KEY: <api-key>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stigg.io/api/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 => [
"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;
}{
"data": {
"entitlements": [
{
"isGranted": true,
"type": "FEATURE",
"accessDeniedReason": null,
"feature": {
"id": "feature-api-calls",
"displayName": "API Calls",
"featureType": "NUMBER",
"featureStatus": "ACTIVE"
},
"usageLimit": 10000,
"hasUnlimitedUsage": false,
"resetPeriod": "MONTH",
"currentUsage": 2500
},
{
"isGranted": true,
"type": "FEATURE",
"accessDeniedReason": null,
"feature": {
"id": "feature-sso",
"displayName": "Single Sign-On",
"featureType": "BOOLEAN",
"featureStatus": "ACTIVE"
}
}
],
"accessDeniedReason": null
}
}{
"message": "<string>",
"code": "BadUserInput",
"reason": "<string>"
}{
"message": "<string>",
"code": "Unauthenticated"
}{
"message": "<string>",
"code": "IdentityForbidden"
}{
"message": "<string>",
"code": "CustomerNotFound"
}{
"message": "<string>",
"code": "RateLimitExceeded"
}Get entitlements state
Retrieves the effective entitlements for a customer or resource, including feature and credit entitlements. Each call reaches the Stigg API directly, so latency reflects a network round trip. For entitlement checks on a hot path (e.g. gating a request in real time), the Stigg Node Server SDK (with its built-in cache) or the Sidecar will typically respond faster and keep working through brief Stigg outages; reach for this endpoint when a live HTTP call is the natural fit, such as from a non-Node backend or a server-side job.
import Stigg from '@stigg/typescript';
const client = new Stigg({
apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});
const response = await client.v1.customers.retrieveEntitlements('x');
console.log(response.data);import os
from stigg import Stigg
client = Stigg(
api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted
)
response = client.v1.customers.retrieve_entitlements(
id="x",
)
print(response.data)package main
import (
"context"
"fmt"
"github.com/stiggio/stigg-go"
"github.com/stiggio/stigg-go/option"
)
func main() {
client := stigg.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.V1.Customers.GetEntitlements(
context.TODO(),
"x",
stigg.V1CustomerGetEntitlementsParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}
package io.stigg.example;
import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.customers.CustomerRetrieveEntitlementsParams;
import io.stigg.models.v1.customers.CustomerRetrieveEntitlementsResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
StiggClient client = StiggOkHttpClient.fromEnv();
CustomerRetrieveEntitlementsResponse response = client.v1().customers().retrieveEntitlements("x");
}
}require "stigg"
stigg = Stigg::Client.new(api_key: "My API Key")
response = stigg.v1.customers.retrieve_entitlements("x")
puts(response)using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Customers;
StiggClient client = new();
CustomerRetrieveEntitlementsParams parameters = new() { ID = "x" };
var response = await client.V1.Customers.RetrieveEntitlements(parameters);
Console.WriteLine(response);stigg v1:customers retrieve-entitlements \
--api-key 'My API Key' \
--id xcurl --request GET \
--url https://api.stigg.io/api/v1/customers/{id}/entitlements \
--header 'X-API-KEY: <api-key>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stigg.io/api/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 => [
"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;
}{
"data": {
"entitlements": [
{
"isGranted": true,
"type": "FEATURE",
"accessDeniedReason": null,
"feature": {
"id": "feature-api-calls",
"displayName": "API Calls",
"featureType": "NUMBER",
"featureStatus": "ACTIVE"
},
"usageLimit": 10000,
"hasUnlimitedUsage": false,
"resetPeriod": "MONTH",
"currentUsage": 2500
},
{
"isGranted": true,
"type": "FEATURE",
"accessDeniedReason": null,
"feature": {
"id": "feature-sso",
"displayName": "Single Sign-On",
"featureType": "BOOLEAN",
"featureStatus": "ACTIVE"
}
}
],
"accessDeniedReason": null
}
}{
"message": "<string>",
"code": "BadUserInput",
"reason": "<string>"
}{
"message": "<string>",
"code": "Unauthenticated"
}{
"message": "<string>",
"code": "IdentityForbidden"
}{
"message": "<string>",
"code": "CustomerNotFound"
}{
"message": "<string>",
"code": "RateLimitExceeded"
}Authorizations
Server API Key
Headers
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).
Path Parameters
The unique identifier of the entity
1 - 255Query Parameters
Resource ID to scope entitlements to a specific resource
255Response
The entitlements state including feature and credit entitlements, and an optional access denied reason.
Response object
The effective entitlements state for a customer or resource.
Show child attributes
Show child attributes
