> ## Documentation Index
> Fetch the complete documentation index at: https://discord-platform-username.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Entitlement Resource

> Reference for Discord entitlement objects that represent user access to premium features.

export const Route = ({method, children}) => {
  return <div className="MDXRoute">
      <span className={"verb" + " " + method.toLowerCase()}>{method}</span>
      <span className="url">{children}</span>
    </div>;
};

export const ManualAnchor = ({id}) => {
  return <div className="MDXManualAnchor" id={id}></div>;
};

Entitlements in Discord represent that a user or guild has access to a premium offering in your application.

Refer to the [Monetization Overview](/developers/monetization/overview) for more information on how to use Entitlements in your app.

### Entitlement Object

<ManualAnchor id="entitlement-object-entitlement-structure" />

###### Entitlement Structure

| Field           | Type               | Description                                                                                   |
| --------------- | ------------------ | --------------------------------------------------------------------------------------------- |
| id              | snowflake          | ID of the entitlement                                                                         |
| sku\_id         | snowflake          | ID of the SKU                                                                                 |
| application\_id | snowflake          | ID of the parent application                                                                  |
| user\_id?       | snowflake          | ID of the user that is granted access to the entitlement's sku                                |
| type            | integer            | [Type of entitlement](/developers/resources/entitlement#entitlement-object-entitlement-types) |
| deleted         | boolean            | Entitlement was deleted                                                                       |
| starts\_at      | ?ISO8601 timestamp | Start date at which the entitlement is valid.                                                 |
| ends\_at        | ?ISO8601 timestamp | Date at which the entitlement is no longer valid.                                             |
| guild\_id?      | snowflake          | ID of the guild that is granted access to the entitlement's sku                               |
| consumed?       | boolean            | For consumable items, whether or not the entitlement has been consumed                        |

<ManualAnchor id="entitlement-object-entitlement-example" />

###### Entitlement Example

```json theme={null}
{
  "id": "1019653849998299136",
  "sku_id": "1019475255913222144",
  "application_id": "1019370614521200640",
  "user_id": "771129655544643584",
  "promotion_id": null,
  "type": 8,
  "deleted": false,
  "gift_code_flags": 0,
  "consumed": false,
  "starts_at": "2022-09-14T17:00:18.704163+00:00",
  "ends_at": "2022-10-14T17:00:18.704163+00:00",
  "guild_id": "1015034326372454400",
  "subscription_id": "1019653835926409216"
}
```

<ManualAnchor id="entitlement-object-entitlement-types" />

###### Entitlement Types

| Type                      | Value | Description                                                    |
| ------------------------- | ----- | -------------------------------------------------------------- |
| PURCHASE                  | 1     | Entitlement was purchased by user                              |
| PREMIUM\_SUBSCRIPTION     | 2     | Entitlement for Discord Nitro subscription                     |
| DEVELOPER\_GIFT           | 3     | Entitlement was gifted by developer                            |
| TEST\_MODE\_PURCHASE      | 4     | Entitlement was purchased by a dev in application test mode    |
| FREE\_PURCHASE            | 5     | Entitlement was granted when the SKU was free                  |
| USER\_GIFT                | 6     | Entitlement was gifted by another user                         |
| PREMIUM\_PURCHASE         | 7     | Entitlement was claimed by user for free as a Nitro Subscriber |
| APPLICATION\_SUBSCRIPTION | 8     | Entitlement was purchased as an app subscription               |

## List Entitlements

<Route method="GET">/applications/[\{application.id}](/developers/resources/application#application-object)/entitlements</Route>

Returns all entitlements for a given app, active and expired.

<ManualAnchor id="list-entitlements-query-string-params" />

###### Query String Params

| param             | type                                                   | description                                                                                                                |
| ----------------- | ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
| user\_id?         | snowflake                                              | User ID to look up entitlements for                                                                                        |
| sku\_ids?         | comma-delimited set of snowflakes                      | Optional list of SKU IDs to check entitlements for                                                                         |
| before?           | snowflake                                              | Retrieve entitlements before this entitlement ID                                                                           |
| after?            | snowflake                                              | Retrieve entitlements after this entitlement ID                                                                            |
| limit?            | integer                                                | Number of entitlements to return, 1-100, default 100                                                                       |
| guild\_id?        | snowflake                                              | Guild ID to look up entitlements for                                                                                       |
| exclude\_ended?   | [boolean](/developers/reference#boolean-query-strings) | Whether or not ended entitlements should be omitted. Defaults to false, ended entitlements are included by default.        |
| exclude\_deleted? | [boolean](/developers/reference#boolean-query-strings) | Whether or not deleted entitlements should be omitted. Defaults to true, deleted entitlements are not included by default. |

```json theme={null}
[
  {
    "id": "1019653849998299136",
    "sku_id": "1019475255913222144",
    "application_id": "1019370614521200640",
    "user_id": "771129655544643584",
    "promotion_id": null,
    "type": 8,
    "deleted": false,
    "gift_code_flags": 0,
    "consumed": false,
    "starts_at": "2022-09-14T17:00:18.704163+00:00",
    "ends_at": "2022-10-14T17:00:18.704163+00:00",
    "guild_id": "1015034326372454400",
    "subscription_id": "1019653835926409216"
  }
]
```

## Get Entitlement

<Route method="GET">/applications/[\{application.id}](/developers/resources/application#application-object)/entitlements/[\{entitlement.id}](/developers/resources/entitlement#entitlement-object)</Route>

Returns an entitlement.

```json theme={null}
{
  "id": "1019653849998299136",
  "sku_id": "1019475255913222144",
  "application_id": "1019370614521200640",
  "user_id": "771129655544643584",
  "promotion_id": null,
  "type": 8,
  "deleted": false,
  "gift_code_flags": 0,
  "consumed": false,
  "starts_at": "2022-09-14T17:00:18.704163+00:00",
  "ends_at": "2022-10-14T17:00:18.704163+00:00",
  "guild_id": "1015034326372454400",
  "subscription_id": "1019653835926409216"
}
```

## Consume an Entitlement

<Route method="POST">/applications/[\{application.id}](/developers/resources/application#application-object)/entitlements/[\{entitlement.id}](/developers/resources/entitlement#entitlement-object)/consume</Route>

For One-Time Purchase consumable SKUs, marks a given entitlement for the user as consumed. The entitlement will have `consumed: true` when using [List Entitlements](/developers/resources/entitlement#list-entitlements).

Returns a `204 No Content` on success.

## Create Test Entitlement

<Route method="POST">/applications/[\{application.id}](/developers/resources/application#application-object)/entitlements</Route>

Creates a test entitlement to a given SKU for a given guild or user. Discord will act as though that user or guild has entitlement to your premium offering.

This endpoint returns a partial entitlement object. It will **not** contain `subscription_id`, `starts_at`, or `ends_at`, as it's valid in perpetuity.

After creating a test entitlement, you'll need to reload your Discord client. After doing so, you'll see that your server or user now has premium access.

<ManualAnchor id="create-test-entitlement-json-params" />

###### JSON Params

| param       | type    | description                                               |
| ----------- | ------- | --------------------------------------------------------- |
| sku\_id     | string  | ID of the SKU to grant the entitlement to                 |
| owner\_id   | string  | ID of the guild or user to grant the entitlement to       |
| owner\_type | integer | `1` for a guild subscription, `2` for a user subscription |

```json theme={null}
{
  "sku_id": "999184799365857331",
  "owner_id": "847184799365857999",
  "owner_type": 1
}
```

## Delete Test Entitlement

<Route method="DELETE">/applications/[\{application.id}](/developers/resources/application#application-object)/entitlements/[\{entitlement.id}](/developers/resources/entitlement#entitlement-object)</Route>

Deletes a currently-active test entitlement. Discord will act as though that user or guild *no longer has* entitlement to your premium offering.

Returns `204 No Content` on success.