Store

If your game has DLC or offers in-app purchases, this manager is for you! The Store Manager allows you to fetch a users' entitlements, as well as being notified when a user is granted an entitlement from a purchase flow for your game.

With this new Store Manager comes a new fun toggle in the Discord app itself: Application Test Mode! While in Application Test Mode, you can freely make "purchases" of SKUs tied to your application. That means you can test buying your game, buying DLC, or going through an IAP flow without any credit card charges.

To enable it, first make sure you have a payment method on file in User Settings -> Billing. Then:

1. Open up the Discord app
2. Click on the settings cog in the bottom left corner
3. Go to Appearance -> allll the way at the bottom
4. Toggle "Developer Mode" on and "Application Test Mode" on, and enter your application ID
5. Exit user settings

You should now see an orange bar across the top of your screen; this means it worked! The dropdown in the orange bar will show you all the available SKUs for that application; you can select one of them to go to its store page. You can also view your Library and see all the branches of your game automagically there waiting for you!

If for some reason the "Install" button is greyed out, please check the following:

1. Do you have a LIVE_BUILD_ID on that branch for this SKU? Check with dispatch branch list <application_id>.
2. Do you have a price tier set for this SKU? If not, pick one!

Once those two conditions are met, you should be good to go! Entitlements "purchased" with this mode enabled can be revoked with the DELETE /entitlements HTTP endpoint, documented below.

If your game has DLC, and a user has purchased that DLC, you may want to check what they should have access to when the game launches. DLC entitlements will always be returned in a FetchEntitlements() call, so your game can check on each startup whether or not a user should have access to a certain new zone, raid, map, etc. based on their entitlements for DLC.

The Discord.SkuType.Consumable type is used for entitlements that may be "consumed" by a game's own server infrastructure. That is to say that if you have in-app purchases like gem bundles, skins, etc., they will be a Consumable SKU type.

What that means is that your game is expected to "consume" these entitlements by doing something on your game server—giving the player a level, more coins, a skin, etc.—and then telling Discord that's been done by calling the POST /entitlements/<id>/consume, documented below. Then, Discord will mark that entitlement as consumed (the consumed field in the returned object will be set to true).

Entitlements to consumable SKUs are intended to signal your game's server/service/database that the user should get something in-game, and that the entitlement should be invalidated afterwards.

The same consumable SKU can be purchased multiple times, but we have some safeguards in place to protect against possible abuse. If you purchase a consumable SKU, you cannot purchase a second one until the first one has been consumed; in the context of normal IAP transactions, your game will be auto-consuming entitlements as soon as they're created. If some malicious folks are somehow able to generate entitlements to your SKUs, they will not be able to consume them without your token, so you'll be safe!

Non-consumable SKUs can only be purchased once.

Fetches the list of SKUs for the connected application, readying them for iteration.

Returns Discord.Result via callback.

None

cs
storeManager.FetchSkus((result) =>
{
  if (result == Discord.Result.Ok)
  {
    Console.WriteLine("Got skus! Now I can iterate over them!");
  }
});

Get the number of SKUs readied by FetchSkus().

Returns Int32.

None

cs
for (int i = 0; i < storeManager.CountSkus(); i++)
{
  var sku = storeManager.GetSkuAt(i);
  Console.WriteLine("Sku is {0}", sku.Name);
}

Gets a SKU by its ID. You must call FetchSkus() first before being able to access SKUs in this way.

Returns Discord.Sku.

cs
storeManager.FetchSkus((_) => {});
var sku = storeManager.GetSku(276467180839763999);
Console.WriteLine("Sku is {0}", sku.Name);

Gets a SKU by index when iterating over SKUs. You must call FetchSkus() first before being able to access SKUs in this way.

Returns Discord.Sku.

cs
storeManager.FetchSkus((result) =>
{
  for (int i = 0; i < storeManager.CountSkus(); i++)
  {
    var sku = storeManager.GetSkuAt(i);
    Console.WriteLine("Sku is {0}", sku.Name);
}
});

Fetches a list of entitlements to which the user is entitled. Applications, DLC, and Bundles will always be returned. Consumables will be returned until they are consumed by the application via the HTTP endpoint.

Returns Discord.Result via callback.

None

cs
storeManager.FetchEntitlements((result) =>
{
  if (result == Discord.Result.Ok)
  {
    Console.WriteLine("Got entitlements!");
  }
});

Get the number of entitlements readied by FetchEntitlements(). You must call FetchEntitlements() first before being able to access SKUs in this way.

Returns Int32.

None

cs
storeManager.FetchEntitlements((result) =>
{
  for (int i = 0; i < storeManager.CountEntitlements(); i++)
  {
    var entitlement = storeManager.GetEntitlementAt(i);
    Console.WriteLine("Entitlement is {0}", entitlement.Name);
  }
});

Gets an entitlement by its id. You must call FetchEntitlements() first before being able to access SKUs in this way.

Returns Discord.Entitlement.

cs
storeManager.FetchEntitlements((result) =>
{
  var entitlement = storeManager.GetEntitlement(276467180839763999);
  Console.WriteLine("Entitlement is {0}", entitlement.Name);
});

Gets an entitlement by index when iterating over a user's entitlements. You must call FetchEntitlements() first before being able to access SKUs in this way.

Returns Discord.Entitlement.

cs
storeManager.FetchEntitlements((result) =>
{
  for (int i = 0; i < storeManager.CountEntitlements(); i++)
  {
    var entitlement = storeManager.GetEntitlementAt(i);
    Console.WriteLine("Entitlement is {0}", entitlement.Name);
  }
});

Returns whether or not the user is entitled to the given SKU ID. You must call FetchEntitlements() first before being able to access SKUs in this way.

Returns bool.

cs
storeManager.FetchEntitlements((result) =>
{
  if (storeManager.HasSkuEntitlement(276467180839763999))
  {
    Console.WriteLine("User has entitlement to this SKU");
  }
  else
  {
    Console.WriteLine("How are you even running this right now...");
  }
});

Opens the overlay to begin the in-app purchase dialogue for the given SKU ID. You must call FetchSkus() first before being able to access SKUs in this way. If the user has enabled the overlay for your game, a purchase modal will appear in the overlay. Otherwise, the Discord client will be auto-focused with a purchase modal.

Returns Discord.Result via callback.

cs
storeManager.FetchSkus((result) =>
{
  storeManager.StartPurchase(276467180839763999, (result) =>
  {
    if (result == Discord.Result.Ok)
    {
      Console.WriteLine("User is in the flow!");
    }
  });
});

Fires when the connected user receives a new entitlement, either through purchase or through a developer grant.

Fires when the connected user loses an entitlement, either by expiration, revocation, or consumption in the case of consumable entitlements.

The following are HTTP requests, and should be handled by your game server, rather than a client. They require a token for an authorization header. This token should be the "Bot token" of your application. To get this token, go to your application in the Dev Portal. In the left sidebar, click the Bot navigation item. You should then click the Add Bot button.

After that, you can copy the token on this page and use it in your HTTP requests. The format for the authorization header should be Authorization: Bot <token>.

Note that parameters with a ? after the name denote optional fields. Parameters with a ? before their type denote nullable fields.

Gets entitlements for a given user. You can use this on your game backend to check entitlements of an arbitrary user, or perhaps in an administrative panel for your support team.

curl https://discord.com/api/v6/applications/461618159171141643/entitlements?user_id=53908232506183680&sku_ids=53908232599983680&with_payments=true&limit=1 \
H "Authorization: Bearer <token>" \
H "Accept: application/json"

// Returns

{
  [
    {
      "user_id": "53908232506183680",
      "sku_id": "53908232599983680",
      "application_id": "461618159171141643",
      "id": "53908232506183999",
      "type": 1,
      "payment": {
        "id": "538491076055400999",
        "currency": "usd",
        "amount": 999,
        "tax": 0,
        "tax_inclusive": false
      }
    }
  ]
}

Fetch an entitlement by its ID. This may be useful in confirming that a user has a given entitlement that another call or the SDK says they do.

curl https://discord.com/api/v6/applications/461618159171141643/entitlements/53908232506183999?with_payment=true \
H "Authorization: Bearer <token>" \
H "Accept: application/json"

// Returns

{
  "user_id": "53908232506183680",
  "sku_id": "53908232599983680",
  "application_id": "461618159171141643",
  "id": "53908232506183999",
  "type": 3,
  "payment": {
    "id": "538491076055400999",
    "currency": "usd",
    "amount": 999,
    "tax": 0,
    "tax_inclusive": false
  }
}

Get all SKUs for an application.

curl https://discord.com/api/v6/applications/461618159171141643/skus \
H "Authorization: Bearer <token>" \
H "Accept: application/json"

// Returns

{
  [
    {
      "id": "53908232599983680",
      "type": 1,
      "dependent_sku_id": null,
      "application_id": "461618159171141643",
      "manifest_labels": ["461618159171111111"],
      "name": "My Awesome Test Game",
      "access_type": 1,
      "features": [1, 2, 3],
      "system_requirements": {},
      "content_ratings": {},
      "release_date": "1999-01-01",
      "legal_notice": {},
      "price_tier": 1099,
      "price": {},
      "premium": false,
      "locales": ["en-US"],
      "bundled_skus": null
    }
  ]
}

Marks a given entitlement for the user as consumed, meaning it will no longer be returned in an entitlements check. Ensure the user was granted whatever items the entitlement was for before consuming it!

curl -X POST https://discord.com/api/v6/applications/461618159171141643/entitlements/53908232506183999/consume \
H "Authorization: Bearer <token>" \
H "Accept: application/json"

// Returns 204 No Content

Deletes a test entitlement for an application. You can only delete entitlements that were "purchased" in developer test mode; these are entitlements of type == TestModePurchase. You cannot use this route to delete arbitrary entitlements that users actually purchased.

curl -X DELETE https://discord.com/api/v6/applications/461618159171141643/entitlements/53908232506183999 \
H "Authorization: Bearer <token>" \
H "Accept: application/json"

// Returns 204 No Content

Creates a discount for the given user on their next purchase of the given SKU. You should call this endpoint from your backend server just before calling StartPurchase for the SKU you wish to discount. The user will then see a discounted price for that SKU at time of payment. The discount is automatically consumed after successful purchase or if the TTL expires.

curl -X PUT https://discord.com/api/v6/store/skus/461618229171141643/discounts/53908232522183999 \
H "Authorization: Bearer <token>" \
H "Accept: application/json" \
H "Content-type: application/json" \
d '{"percent_off": 10, "ttl": 600}'

// Returns 204 No Content

Deletes the currently active discount on the given SKU for the given user. You do not need to call this after a user has made a discounted purchase; successful discounted purchases will automatically remove the discount for that user for subsequent purchases.

curl -X DELETE https://discord.com/api/v6/store/skus/461618229171141643/discounts/53908232522183999 \
H "Authorization: Bearer <token>" \
H "Accept: application/json"

// Returns 204 No Content