---
title: "List entitlements"
method: GET
path: "/v1/entitlements"
tags: ["Entitlements"]
---

# List entitlements

`GET /v1/entitlements`

## Query parameters

- `limit` integer
- `customerId` string
- `subscriptionId` string
- `cursorToken` string
- `isActive` boolean
- `sort` 'asc' | 'desc'

## Response `200`

Success

- object — List of entitlements
  - `status` 'SUCCEEDED', required
  - `data` ListEntitlementsResponse, required
    - `entitlements` object[], required
      - `id` string
      - `createdAt` number
      - `updatedAt` number
      - `_lock` object
        - `locked` boolean, required
        - `lockedAt` number
        - `unlockedAt` number
        - `owner` string
      - `subscriptionId` string
      - `offerId` string
      - `productId` string, required
      - `invoiceId` string
      - `livemode` boolean, required
      - `revocationDate` number
      - `revocationReason` string
      - `customerId` string, required
      - `merchantId` string, required
      - `startPeriod` number
      - `endPeriod` number
      - `idempotencyKey` string
    - `hasMore` boolean, required
    - `nextPageToken` string

## Other responses

- `400` — Bad request
- `401` — Unauthorized

---

[API](https://skmtc.dev/breeze/apis/breeze-api.md) · [All operations](https://skmtc.dev/breeze/apis/breeze-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/breeze/breeze-api/revisions/8911892bdf29/schema)
