Skip to main content
GET
/
api
/
v1
/
subscriptions
/
{subscription_id}
/
v2
/
entitlements-usage
Python SDK
from metrifox_sdk import MetrifoxClient

client = MetrifoxClient(api_key="your_api_key")

# Get entitlements usage for a subscription
subscription_id = "625f5cee-259b-4994-b7eb-416b9e551f2c"
response = client.subscriptions.get_entitlements_usage(subscription_id)

for entitlement in response['data']:
    print(f"Feature: {entitlement['feature_name']} ({entitlement['feature_key']})")
    print(f"  Type: {entitlement['type']}")
    print(f"  Active: {entitlement['active']}")
    if entitlement['purchased_pool']:
        pool = entitlement['purchased_pool']
        print(f"  Purchased: {pool['used']}/{pool['amount']} used, {pool['balance']} remaining")
    if entitlement['rollover_quantity_pool']:
        pool = entitlement['rollover_quantity_pool']
        print(f"  Rollover: {pool['used']}/{pool['amount']} used, {pool['balance']} remaining")
{
  "statusCode": 200,
  "message": "Entitlements usage fetched successfully",
  "meta": {},
  "data": [
    {
      "id": "120007eb-c6f7-4439-b7a9-75f09d60079e",
      "feature_key": "feature_skills_audit",
      "type": "per_use",
      "included_pool": null,
      "purchased_pool": {
        "balance": "2.0",
        "used": "0.0",
        "amount": "2.0",
        "next_reset_at": "2026-03-12T16:55:21.847Z",
        "active": true
      },
      "pay_as_you_go_pool": null,
      "rollover_quantity_pool": {
        "balance": "4.0",
        "used": "0.0",
        "amount": "4.0",
        "active": true
      },
      "active": true,
      "feature_name": "Skills Audit"
    },
    {
      "id": "2e7f7fd8-c723-4d7c-98e5-b8239ab5226e",
      "feature_key": "feature_seats",
      "type": "persistent_use",
      "included_pool": null,
      "purchased_pool": {
        "balance": "0.0",
        "used": "3.0",
        "amount": "3.0",
        "next_reset_at": "2026-03-12T16:55:21.847Z",
        "active": true
      },
      "pay_as_you_go_pool": null,
      "rollover_quantity_pool": null,
      "active": true,
      "feature_name": "Seats"
    }
  ],
  "errors": {}
}

Authorizations

x-api-key
string
header
required

Path Parameters

subscription_id
string<uuid>
required

The unique subscription identifier (UUID)

Response

Entitlements usage fetched successfully

statusCode
integer
Example:

200

message
string
Example:

"Entitlements usage fetched successfully"

meta
object

Additional metadata

data
object[]

Array of entitlement usage records

errors
object

Any errors that occurred