Entitlements

Entitlements in Discord represent a user or guild's access to a specific SKU. Entitlements can represent purchases, subscriptions, or gifts, and are used to power many different features in Discord.

Entitlement Object

Entitlement Structure

Tenant Metadata Structure

Quest Rewards Metadata Structure

Entitlement Type

Entitlement Fulfillment Status

Entitlement Source Type

Example Entitlement

{
  "id": "1014639973498097686",
  "sku_id": "557494559257526272",
  "application_id": "557494559257526272",
  "user_id": "852892297661906993",
  "promotion_id": null,
  "type": 3,
  "deleted": false,
  "gift_code_flags": 0,
  "starts_at": null,
  "ends_at": null,
  "branches": ["557494559257526272"],
  "gift_code_batch_id": "916443614618464296"
}

Gift Code Object

A gift from one user to another, which can be redeemed for an entitlement.

Gift Code Structure

Gift Code Flags

Gift Style

Example Gift Code

{
  "code": "2CG6SV9QtRxerJTgCYNDnU7M",
  "sku_id": "521847234246082599",
  "application_id": "521842831262875670",
  "uses": 1,
  "max_uses": 1,
  "expires_at": null,
  "redeemed": false,
  "batch_id": "1215710455985610833",
  "store_listing": {
    "id": "521848044908576803",
    "summary": " ",
    "sku": {
      "id": "521847234246082599",
      "type": 5,
      "product_line": 1,
      "dependent_sku_id": null,
      "application_id": "521842831262875670",
      "manifest_labels": null,
      "access_type": 1,
      "name": "Nitro",
      "features": [],
      "release_date": null,
      "premium": false,
      "slug": "nitro",
      "flags": 68,
      "show_age_gate": false
    },
    "thumbnail": {
      "id": "971526227435323423",
      "size": 227396,
      "mime_type": "image/png",
      "width": 834,
      "height": 474
    },
    "benefits": []
  },
  "subscription_plan_id": "642251038925127690"
}

Gift Code Batch Object

A batch of gift codes created together.

Gift Code Batch Structure

Example Gift Code Batch

{
  "id": "916443614618464296",
  "sku_id": "557494559257526272",
  "amount": 10,
  "description": "Holiday Giveaway",
  "entitlement_branches": ["557494559257526272"]
}

Endpoints

Returns a list of entitlement objects granted to the current user, both active and expired.

Query String Params

Returns a list of entitlement objects that the current user can gift.

Query String Params

Returns a list of entitlement objects granted to the given guild, both active and expired.

Query String Params

Returns a list of entitlement objects for the given application, both active and expired.

Query String Params

Returns a list of entitlement objects granted to the current user for the given application.

Query String Params

Returns an entitlement object for the given application and entitlement ID.

Creates a test entitlement to a given subscription SKU for a given guild or user. Returns an entitlement object on success. Fires an Entitlement Create Gateway event.

JSON Params

Entitlement Owner Type

For one-time purchase consumable SKUs, marks a given entitlement for the user as consumed. Returns a 204 empty response on success. Fires an Entitlement Update Gateway event.

Deletes a currently-active test entitlement. Returns a 204 empty response on success. Fires an Entitlement Delete Gateway event.

Returns a gift code object for the given code.

Query String Params

Redeems a gift code for the current user. Returns an entitlement object on success. Fires an Entitlement Create and Gift Code Update Gateway event.

JSON Params

Returns a list of gift code objects that the current user has created.

Query String Params

Creates a gift code. Requires an eligible giftable entitlement. Returns a gift code object on success. Fires a Gift Code Create Gateway event.

JSON Params

Revokes a gift code created by the current user. Returns a 204 empty response on success.

Returns a list of gift code batch objects for the given application. User must be the owner of the application or member of the owning team.

Creates a batch of gift codes. Returns a gift code batch object on success. User must be the owner of the application or developer of the owning team.

JSON Params

Returns a CSV file containing all gift codes in the given batch. User must be the owner of the application or member of the owning team.