# list entitlement cancellation requests

`GET https://api.suger.cloud/org/{orgId}/entitlement/{entitlementId}/cancel`

List entitlement cancellation requests with filtering, sorting, and pagination.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `orgId` | path | string | yes | Organization ID |
| `entitlementId` | path | string | yes | Entitlement ID |
| `page_size` | query | integer | no | Number of items per page (default 20, max 1000) |
| `page_number` | query | integer | no | Page number (default 1) |
| `q` | query | string | no | LISP-style filter expression (e.g., '(= status \ |
| `s` | query | string | no | Sort fields: 'field:asc,field2:desc' or '-field,field2' format (e.g., 'created_at:desc,status:asc') |

## Responses

### 200 — Paginated list of entitlement cancellation requests

Content-Type: `application/json` · Schema: `crud.ListBaseResponse-orm_EntitlementCancellationRequest`

**`crud.ListBaseResponse-orm_EntitlementCancellationRequest`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | array<orm.EntitlementCancellationRequest> | no |  |
| `page_number` | integer | no |  |
| `page_size` | integer | no |  |
| `total_count` | integer | no |  |

**`orm.EntitlementCancellationRequest`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdAt` | string | no | CreatedAt holds the value of the "created_at" field. |
| `createdBy` | LastModifiedBy | no |  |
| `entitlementID` | string | no | EntitlementID holds the value of the "entitlement_id" field. |
| `externalRequestID` | string | no | ExternalRequestID holds the value of the "external_request_id" field. |
| `id` | string | no | ID of the ent. |
| `info` | EntitlementCancellationRequestInfo | no |  |
| `lastUpdatedAt` | string | no | LastUpdatedAt holds the value of the "last_updated_at" field. |
| `organizationID` | string | no | OrganizationID holds the value of the "organization_id" field. |
| `partner` | string | no | Partner holds the value of the "partner" field. |
| `status` | string | no | Status holds the value of the "status" field. |
| `statusMessage` | string | no | StatusMessage holds the value of the "status_message" field. |

**`LastModifiedBy`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `email` | string | no | The email of the creator. |
| `entityId` | string | no | The ID of the creator. |
| `entityType` | EntityType | no |  |
| `name` | string | no | The name of the creator. |

**`EntitlementCancellationRequestInfo`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `awsClientToken` | string | no | AwsClientToken is the UUID client token for idempotency. |
| `awsReasonCode` | string | no | AwsReasonCode is the cancellation reason code from AWS SDK. |
| `awsReasonDescription` | string | no | AwsReasonDescription is the description of the cancellation reason. |

### 400 — Bad request error

Content-Type: `application/json`

### 500 — Internal server error

Content-Type: `application/json`

---

Interactive API reference: https://doc.suger.io/api/