# Entitlements

## List tenant entitlements

`client.Tenants.Entitlements.Get(ctx, tenantID) (*TenantEntitlements, error)`

**get** `/tenants/{tenant_id}/entitlements`

List of innate entitlements available for the Tenant.

### Parameters

- `tenantID string`

### Returns

- `type TenantEntitlements struct{…}`

  - `AllowAddSubdomain TenantEntitlementsAllowAddSubdomain`

    - `Type TenantEntitlementsAllowAddSubdomainType`

      - `const TenantEntitlementsAllowAddSubdomainTypeBool TenantEntitlementsAllowAddSubdomainType = "bool"`

    - `Value bool`

  - `AllowAutoAcceptInvites TenantEntitlementsAllowAutoAcceptInvites`

    - `Type TenantEntitlementsAllowAutoAcceptInvitesType`

      - `const TenantEntitlementsAllowAutoAcceptInvitesTypeBool TenantEntitlementsAllowAutoAcceptInvitesType = "bool"`

    - `Value bool`

  - `CNAMESetupAllowed TenantEntitlementsCNAMESetupAllowed`

    - `Type TenantEntitlementsCNAMESetupAllowedType`

      - `const TenantEntitlementsCNAMESetupAllowedTypeBool TenantEntitlementsCNAMESetupAllowedType = "bool"`

    - `Value bool`

  - `CustomEntitlements []TenantEntitlementsCustomEntitlement`

    - `Allocation TenantEntitlementsCustomEntitlementsAllocation`

      - `type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation struct{…}`

        - `Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType`

          - `const TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationTypeMaxCount TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType = "max_count"`

        - `Value int64`

      - `type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation struct{…}`

        - `Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType`

          - `const TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationTypeBool TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType = "bool"`

        - `Value bool`

      - `type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation struct{…}`

        - `Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType`

          - `const TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationTypeEmpty TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType = ""`

        - `Value unknown`

    - `Feature TenantEntitlementsCustomEntitlementsFeature`

      - `Key string`

  - `MhsCertificateCount TenantEntitlementsMhsCertificateCount`

    - `Type TenantEntitlementsMhsCertificateCountType`

      - `const TenantEntitlementsMhsCertificateCountTypeMaxCount TenantEntitlementsMhsCertificateCountType = "max_count"`

    - `Value int64`

  - `PartialSetupAllowed TenantEntitlementsPartialSetupAllowed`

    - `Type TenantEntitlementsPartialSetupAllowedType`

      - `const TenantEntitlementsPartialSetupAllowedTypeBool TenantEntitlementsPartialSetupAllowedType = "bool"`

    - `Value bool`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  tenantEntitlements, err := client.Tenants.Entitlements.Get(context.TODO(), "tenant_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", tenantEntitlements.AllowAddSubdomain)
}
```

#### Response

```json
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "allow_add_subdomain": {
      "type": "bool",
      "value": true
    },
    "allow_auto_accept_invites": {
      "type": "bool",
      "value": true
    },
    "cname_setup_allowed": {
      "type": "bool",
      "value": true
    },
    "custom_entitlements": [
      {
        "allocation": {
          "type": "max_count",
          "value": 0
        },
        "feature": {
          "key": "key"
        }
      }
    ],
    "mhs_certificate_count": {
      "type": "max_count",
      "value": 0
    },
    "partial_setup_allowed": {
      "type": "bool",
      "value": true
    }
  },
  "success": true
}
```

## Domain Types

### Tenant Entitlements

- `type TenantEntitlements struct{…}`

  - `AllowAddSubdomain TenantEntitlementsAllowAddSubdomain`

    - `Type TenantEntitlementsAllowAddSubdomainType`

      - `const TenantEntitlementsAllowAddSubdomainTypeBool TenantEntitlementsAllowAddSubdomainType = "bool"`

    - `Value bool`

  - `AllowAutoAcceptInvites TenantEntitlementsAllowAutoAcceptInvites`

    - `Type TenantEntitlementsAllowAutoAcceptInvitesType`

      - `const TenantEntitlementsAllowAutoAcceptInvitesTypeBool TenantEntitlementsAllowAutoAcceptInvitesType = "bool"`

    - `Value bool`

  - `CNAMESetupAllowed TenantEntitlementsCNAMESetupAllowed`

    - `Type TenantEntitlementsCNAMESetupAllowedType`

      - `const TenantEntitlementsCNAMESetupAllowedTypeBool TenantEntitlementsCNAMESetupAllowedType = "bool"`

    - `Value bool`

  - `CustomEntitlements []TenantEntitlementsCustomEntitlement`

    - `Allocation TenantEntitlementsCustomEntitlementsAllocation`

      - `type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation struct{…}`

        - `Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType`

          - `const TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationTypeMaxCount TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType = "max_count"`

        - `Value int64`

      - `type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation struct{…}`

        - `Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType`

          - `const TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationTypeBool TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType = "bool"`

        - `Value bool`

      - `type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation struct{…}`

        - `Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType`

          - `const TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationTypeEmpty TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType = ""`

        - `Value unknown`

    - `Feature TenantEntitlementsCustomEntitlementsFeature`

      - `Key string`

  - `MhsCertificateCount TenantEntitlementsMhsCertificateCount`

    - `Type TenantEntitlementsMhsCertificateCountType`

      - `const TenantEntitlementsMhsCertificateCountTypeMaxCount TenantEntitlementsMhsCertificateCountType = "max_count"`

    - `Value int64`

  - `PartialSetupAllowed TenantEntitlementsPartialSetupAllowed`

    - `Type TenantEntitlementsPartialSetupAllowedType`

      - `const TenantEntitlementsPartialSetupAllowedTypeBool TenantEntitlementsPartialSetupAllowedType = "bool"`

    - `Value bool`