API Reference

V1

Omni AI

Entitlements

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Delete Entitlement

v1.omni_ai.entitlements.delete_entitlement(strentitlement_id) -> EntitlementDeleteEntitlementResponse

DELETE/v1/omni-ai/entitlements/{entitlement_id}

Revoke one entitlement grant by id.

ParametersExpand Collapse

entitlement_id: str

ReturnsExpand Collapse

class EntitlementDeleteEntitlementResponse: …

data: DeleteEntitlementResponse

entitlement_id: str

revoked: bool

Delete Entitlement

Python

HTTP

TypeScript

Python

Java

Go

CLI Tool

from clear_street import ClearStreet

client = ClearStreet(
    api_key="My API Key",
)
response = client.v1.omni_ai.entitlements.delete_entitlement(
    "entitlement_id",
)
print(response)

200 example

{
  "metadata": {
    "request_id": "request_id",
    "next_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "page_number": 0,
    "previous_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "total_items": 0,
    "total_pages": 0
  },
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero",
    "details": [
      {
        "foo": "bar"
      }
    ]
  },
  "data": {
    "entitlement_id": "entitlement_id",
    "revoked": true
  }
}

Returns Examples

200 example

{
  "metadata": {
    "request_id": "request_id",
    "next_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "page_number": 0,
    "previous_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "total_items": 0,
    "total_pages": 0
  },
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero",
    "details": [
      {
        "foo": "bar"
      }
    ]
  },
  "data": {
    "entitlement_id": "entitlement_id",
    "revoked": true
  }
}