entitlements reference

This reference follows the current server implementation. Use the SDK for customer flows; it manages identity proof and retries. Authentication and errors apply to every endpoint. Types below describe JSON: dates are ISO strings, ? means optional, and null differs from an omitted field. Responses may include additional fields. Schemas also enforce constraints that TypeScript cannot express; download the request JSON Schemas. Named response types are defined in the data model reference.

GET /v1/entitlements/catalog

Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Request

Use the path parameters above and any query options described below.

Response

JSON response shape

EntitlementCatalogResponse

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: handleGetEntitlementCatalog.

GET /v1/entitlements

Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Request

Supply these values as query parameters. Path parameters remain in the URL.

{ revision: string;
  enabled: boolean;
  entitlementIdentifier: string;
  members: { grantId: string;
  customerId: string;
  }[];
  }

{ version: 2;
  appId: string;
  customerId: string;
  transactionId: string;
  entitlementId: string;
  periodStart: string;
  periodEnd: string | null;
  }

Response

JSON response shape

{ error: string;
  message: string;
  }

JSON response shape

{}

JSON response shape

{ [x: string]: EntitlementStatus;
  }

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: handleGetEntitlements.