Entitlements

This section documents everything related to entitlements, which represent access to SKUs.

Discord Models

Entitlement

Attributes
Methods
class disnake.Entitlement[source]

Represents an entitlement.

This is usually retrieved using Client.entitlements(), from Interaction.entitlements when using interactions, or provided by events (e.g. on_entitlement_create()).

Note that some entitlements may have ended already; consider using is_active() to check whether a given entitlement is considered active at the current time, or use exclude_ended=True when fetching entitlements using Client.entitlements().

You may create new entitlements for testing purposes using Client.create_entitlement().

x == y

Checks if two Entitlements are equal.

x != y

Checks if two Entitlements are not equal.

hash(x)

Returns the entitlement’s hash.

New in version 2.10.

id

The entitlement’s ID.

Type:

int

type

The entitlement’s type.

Type:

EntitlementType

sku_id

The ID of the associated SKU.

Type:

int

user_id

The ID of the user that is granted access to the entitlement’s SKU.

See also user.

Type:

int | None

guild_id

The ID of the guild that is granted access to the entitlement’s SKU.

See also guild.

Type:

int | None

application_id

The parent application’s ID.

Type:

int

deleted

Whether the entitlement has been deleted.

Type:

bool

consumed

Whether the entitlement has been consumed. Only applies to consumable items, i.e. those associated with a consumable SKU.

Type:

bool

starts_at

The time at which the entitlement starts being active. Set to None when this is a test entitlement.

Type:

datetime.datetime | None

ends_at

The time at which the entitlement stops being active.

You can use is_active() to check whether this entitlement is still active.

Type:

datetime.datetime | None

property created_at[source]

Returns the entitlement’s creation time in UTC.

Type:

datetime.datetime

property guild[source]

The guild that is granted access to this entitlement’s SKU, if applicable.

Type:

Guild | None

property user[source]

The user that is granted access to this entitlement’s SKU, if applicable.

Requires the user to be cached. See also user_id.

Type:

User | None

is_active()[source]

Whether the entitlement is currently active, based on starts_at and ends_at.

Always returns True for test entitlements.

Return type:

bool

await consume()[source]

This function is a coroutine.

Marks the entitlement as consumed.

This is only valid for consumable one-time entitlements; see consumed.

Raises:
await delete()[source]

This function is a coroutine.

Deletes the entitlement.

This is only valid for test entitlements; you cannot use this to delete entitlements that users purchased.

Raises:

Enumerations

EntitlementType

class disnake.EntitlementType[source]

Represents the type of an entitlement.

New in version 2.10.

purchase

Represents an entitlement purchased by a user.

premium_subscription

Represents an entitlement for a Discord Nitro subscription.

developer_gift

Represents an entitlement gifted by the application developer.

test_mode_purchase

Represents an entitlement purchased by a developer in application test mode.

free_purchase

Represents an entitlement granted when the SKU was free.

user_gift

Represents an entitlement gifted by another user.

premium_purchase

Represents an entitlement claimed by a user for free as a Discord Nitro subscriber.

application_subscription

Represents an entitlement for an application subscription.

Events