Check access - Unprice Documentation

const { result, error } = await unprice.access.check({
  customerId: "cus_1234567890",
  featureSlug: "ai-messages"
});

if (error) {
  console.error(error.message);
  return;
}

console.log(result);

{
  "allowed": true,
  "featureSlug": "ai-messages",
  "usage": 42,
  "limit": 100,
  "spending": {
    "ledgerAmount": 4200000000,
    "currency": "USD",
    "displayAmount": "$42",
    "scale": 8
  }
}

const { result, error } = await unprice.access.check({
  customerId: "cus_1234567890",
  featureSlug: "ai-messages"
});

if (error) {
  console.error(error.message);
  return;
}

console.log(result);

{
  "allowed": true,
  "featureSlug": "ai-messages",
  "usage": 42,
  "limit": 100,
  "spending": {
    "ledgerAmount": 4200000000,
    "currency": "USD",
    "displayAmount": "$42",
    "scale": 8
  }
}

const { result, error } = await unprice.access.check({
  customerId: "cus_1234567890",
  featureSlug: "ai-messages"
});

if (error) {
  console.error(error.message);
  return;
}

console.log(result);

{
  "allowed": true,
  "featureSlug": "ai-messages",
  "usage": 42,
  "limit": 100,
  "spending": {
    "ledgerAmount": 4200000000,
    "currency": "USD",
    "displayAmount": "$42",
    "scale": 8
  }
}

Request

string

required

The customer ID to check.

string

required

The feature slug to check.

number

Optional epoch-millisecond timestamp for a recent point-in-time check.

Response

boolean

required

Whether the feature is usable for the customer at the requested timestamp.

string

required

The feature slug that was checked.

string

Why the feature is not usable. Omitted when allowed is true.

number

Current usage for usage-based features.

number

Active quota-window limit for usage features, or subscribed quantity for tier/package features. null means unlimited.

object

Current priced usage spend for usage-based features.

number

Current spend in ledger scale units.

string

ISO currency code for the spend.

string

Ready-to-render localized spend, such as $42.

number

Decimal scale for ledgerAmount. Currently 8.

object | null

The quota window represented by usage and limit, with startAt, endAt, and periodKey. Timestamps use epoch milliseconds. endAt is exclusive and can be null for an open-ended window. The object is null when active grants use different windows.

​Request

​Response

Request

Response