const { result, error } = await unprice.customers.getEntitlements("cus_1234567890");

if (error) {
  // handle potential network or bad request error
  // a link to our docs will be in the `error.docs` field
  console.error(error.message);
  return;
}

console.log(result);
{
  "entitlements": [
    {
      "featureSlug": "feature_1",
      "granted": true,
      "usage": {
        "used": 100,
        "limit": 1000
      }
    }
  ]
}
const { result, error } = await unprice.customers.getEntitlements("cus_1234567890");

if (error) {
  // handle potential network or bad request error
  // a link to our docs will be in the `error.docs` field
  console.error(error.message);
  return;
}

console.log(result);
{
  "entitlements": [
    {
      "featureSlug": "feature_1",
      "granted": true,
      "usage": {
        "used": 100,
        "limit": 1000
      }
    }
  ]
}

Request

customerId
string
required
The ID of the customer to get entitlements for

Response

entitlements
array
required
Array of entitlements for the customer
entitlements[].featureSlug
string
required
The slug of the feature
entitlements[].granted
boolean
required
Whether the feature is granted to the customer
entitlements[].usage
object
Usage information for the feature
entitlements[].usage.used
number
The amount of usage consumed
entitlements[].usage.limit
number
The usage limit for the feature