---
title: Entitlements
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/typescript)

[Tenants](https://developers.cloudflare.com/api/typescript/resources/tenants)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Entitlements

##### [List tenant entitlements](https://developers.cloudflare.com/api/typescript/resources/tenants/subresources/entitlements/methods/get)

client.tenants.entitlements.get(stringtenantID, RequestOptionsoptions?): [TenantEntitlements](<https://developers.cloudflare.com/api/typescript/resources/tenants#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)>) {allow\_add\_subdomain, allow\_auto\_accept\_invites, cname\_setup\_allowed, 3 more }

GET/tenants/{tenant\_id}/entitlements

##### ModelsExpand Collapse

<details>

<summary>

TenantEntitlements {allow\_add\_subdomain, allow\_auto\_accept\_invites, cname\_setup\_allowed, 3 more }

</summary>

<details>

<summary>

allow\_add\_subdomain: AllowAddSubdomain {type, value }

</summary>

type: "bool"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_add_subdomain%20%3E%20(property)%20type">Link to this property</a>

value: boolean

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_add_subdomain%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_add_subdomain">Link to this property</a>

<details>

<summary>

allow\_auto\_accept\_invites: AllowAutoAcceptInvites {type, value }

</summary>

type: "bool"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_auto_accept_invites%20%3E%20(property)%20type">Link to this property</a>

value: boolean

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_auto_accept_invites%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_auto_accept_invites">Link to this property</a>

<details>

<summary>

cname\_setup\_allowed: CNAMESetupAllowed {type, value }

</summary>

type: "bool"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20cname_setup_allowed%20%3E%20(property)%20type">Link to this property</a>

value: boolean

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20cname_setup_allowed%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20cname_setup_allowed">Link to this property</a>

<details>

<summary>

custom\_entitlements: Array&lt;CustomEntitlement&gt;| null

</summary>

<details>

<summary>

allocation: OrganizationsAPIMaxCountAllocation {type, value } | OrganizationsAPIBoolAllocation {type, value } | OrganizationsAPINullAllocation {type, value }

</summary>

One of the following:

<details>

<summary>

OrganizationsAPIMaxCountAllocation {type, value }

</summary>

type: "max\_count"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%200%20%3E%20(property)%20type">Link to this property</a>

value: number

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%200%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%200">Link to this property</a>

<details>

<summary>

OrganizationsAPIBoolAllocation {type, value }

</summary>

type: "bool"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%201%20%3E%20(property)%20type">Link to this property</a>

value: boolean

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%201%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%201">Link to this property</a>

<details>

<summary>

OrganizationsAPINullAllocation {type, value }

</summary>

type: ""

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%202%20%3E%20(property)%20type">Link to this property</a>

value?: unknown

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%202%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%202">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation">Link to this property</a>

<details>

<summary>

feature: Feature {key }

</summary>

key: string

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20feature%20%3E%20(property)%20key">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20feature">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements">Link to this property</a>

<details>

<summary>

mhs\_certificate\_count: MhsCertificateCount {type, value }

</summary>

type: "max\_count"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20mhs_certificate_count%20%3E%20(property)%20type">Link to this property</a>

value: number

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20mhs_certificate_count%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20mhs_certificate_count">Link to this property</a>

<details>

<summary>

partial\_setup\_allowed: PartialSetupAllowed {type, value }

</summary>

type: "bool"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20partial_setup_allowed%20%3E%20(property)%20type">Link to this property</a>

value: boolean

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20partial_setup_allowed%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20partial_setup_allowed">Link to this property</a>

</details>

[Link to this property](<#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)>)