Subscription Workflow Tests

[positivesquare]

Hi everyone.
I am working on implementing subscription payments on a discord app and I am stuck at the point where I need to test the subscription workflow from the moment when a user subscribes to the moment where the user cancels the subscription or is getting renewed.
As I understand the documentation, there isn't a way to test trigger the events generated by subscription create/update/delete apart from subscribing from a dev account to make it free. With that said and done, you are stuck with the subscription on your account with no way to remove it in order to try again, unless you wait until the subscription has ran out in a month.
Another issue that I cannot find a solution for removing active/canceled test subscriptions from a guild. This way I do not have to create multiple guilds every time I want to create a new subscription.
Removed SKUs from the account still show if you are fetching them from the API making the debugging or the testing very difficult.
I apologise if I have missed the documentation where it tells you how to do this.
Any ideas are much appreciated.

[epsilonion-liam]

I am also struggling with this.

There is no way to sandbox the full process.
I have had issues all the way through the process and wish the documentation was more thorough with more explanation.

Making more temporary guilds to test the full work flow is not very efficient and pulls on discords resources, personally I think more love needs to go into the app subscription (I am looking for guild subscriptions).

If sandboxing to test the full work flow and documentation was better I think that I would have a chance of getting guild subscription rolled out for my bot rolled out faster and more efficient.

[epsilonion-liam]

Oh man I am pulling my hair out with this.

Trying to create test entitlements and getting this

ERROR - Failed to create test entitlement: Failed to create test entitlement: {"message": "405: Method Not Allowed", "code": 0}

I am probably overlooking something but been at this for days now.

Here is the script if someone more experienced can help me i would be grateful.

import logging
from nextcord.ext import commands
from nextcord import Guild
import aiohttp
import os
from typing import Optional

Set up logging

logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')
logger = logging.getLogger(name)

DISCORD_API_BASE_URL = "https://discord.com/api/v10"
SKU_ID = "############"

class SubscriptionManager(commands.Cog):
def init(self, bot: commands.Bot, db_pool):
self.bot = bot
self.db_pool = db_pool
self.bot_token = os.getenv('BOT_TOKEN')
self.application_id = os.getenv('APPLICATION_ID')

async def create_test_entitlement(self, owner_id: str, owner_type: int) -> dict:
    """Create a test entitlement to a given SKU for a guild or user."""
    url = f"{DISCORD_API_BASE_URL}/applications/{self.application_id}/entitlements"
    headers = {"Authorization": f"Bot {self.bot_token}"}
    data = {
        "sku_id": SKU_ID,
        "owner_id": owner_id,
        "owner_type": owner_type
    }

    async with aiohttp.ClientSession() as session:
        async with session.post(url, headers=headers, json=data) as response:
            if response.status == 200 or response.status == 201:
                return await response.json()
            else:
                error_text = await response.text()
                raise Exception(f"Failed to create test entitlement: {error_text}")

async def delete_test_entitlement(self, entitlement_id: str) -> None:
    """Delete a currently-active test entitlement."""
    url = f"{DISCORD_API_BASE_URL}/applications/{self.application_id}/entitlements/{entitlement_id}"
    headers = {"Authorization": f"Bot {self.bot_token}"}

    async with aiohttp.ClientSession() as session:
        async with session.delete(url, headers=headers) as response:
            if response.status != 204:
                error_text = await response.text()
                raise Exception(f"Failed to delete test entitlement: {error_text}")

@commands.command(name="add_test_entitlement")
@commands.has_permissions(administrator=True)
async def add_test_entitlement(self, ctx: commands.Context, guild: Optional[Guild] = None) -> None:
    """Add a test entitlement to the guild."""
    guild = guild or ctx.guild
    try:
        entitlement = await self.create_test_entitlement(str(guild.id), 1)
        await ctx.send(f"Test entitlement created for {guild.name}: {entitlement}")
        logger.info(f"Created test entitlement for {guild.name}: {entitlement}")
    except Exception as e:
        logger.error(f"Failed to create test entitlement: {e}")
        await ctx.send(f"Failed to create test entitlement for {guild.name}")

@commands.command(name="remove_test_entitlement")
@commands.has_permissions(administrator=True)
async def remove_test_entitlement(self, ctx: commands.Context, entitlement_id: str, guild: Optional[Guild] = None) -> None:
    """Remove a test entitlement from the guild."""
    guild = guild or ctx.guild
    try:
        await self.delete_test_entitlement(entitlement_id)
        await ctx.send(f"Test entitlement removed for {guild.name}.")
        logger.info(f"Removed test entitlement for {guild.name}.")
    except Exception as e:
        logger.error(f"Failed to remove test entitlement: {e}")
        await ctx.send(f"Failed to remove test entitlement for {guild.name}.")

Setup function to load the cog

def setup(bot: commands.Bot):
bot.add_cog(SubscriptionManager(bot, bot.db_pool))

[positivesquare]

I totally agree with you.
I have asked on many Discord servers where developers chat and had no response.
In documentation you are told that Entitlements are assigned to guilds/users and prove access to an SKU. You also get subscription updates which should NOT be used as a proof of access to that SKU but they do show you some state of the subscription.
It is all over the place in terms of checking subscription access, sku access, end_at: is populated when the subscription has ended in the Entitlement_update.
There aren't more examples on how this relationship between entitlements and subscriptions work, what is the correct way to check subscriptions status in different scenarios.
I have had many issues testing subscription workflows on many guilds. Tech support has helped me to fix subscriptions on my account to continue tests but the process is slow and unnecessary.

Regarding your issue. I am not familiar with Python or Discord.py but judging by the error you are getting, it looks like your issue is here:

async with aiohttp.ClientSession() as session:
        async with session.post(url, headers=headers, json=data) as response:
            if response.status == 200 or response.status == 201:
                return await response.json()

Wherever you are making that request, it does not supports the method you are using (post).
As I said, I am not familiar with Python. I don't want to steer you in the wrong direction so please take my response with a pinch of salt.

Going back to the workflow of subscriptions, I am going to look into this over the next few days and if you wish to brainstorm together, drop me a message and we can meet on a discord server to chat.
Hope you find a solution to the problem mentioned above.

[epsilonion-liam]

I figured out my issue it refuses to get the application id from the environment variables, its been a pita.

I can not create a bloody test entitlement DEBUG - Response Text: {"message": "An entitlement has already been granted for this resource", "code": 40074}

This is because I have to wait for a month for the test subscription to be deleted when subscribing to see how the workflow works and the json returned, basically with the limited documentation I did not fully understand the process but now I am aware.

There needs to be an easy way to test the full workflow without the month wait for it to be deleted, a simple switch in the developers portal for an app to put the subscription workflow in a sandbox like when working with PayPal payment processes.

This feature of the discord API/service seriously need some more work to be done on it and some documentation updates with warnings about the month wait for a subscription to be deleted.

[positivesquare]

There is an api endpoint for deleting test entitlements. If you make a purchase through the in-app menu, you do have to wait a month…. But indeed, you are correct. If you make a test purchase using the in-app menu, you have to wait for a month for it to change status if canceled or renew.

…

________________________________ From: Liam Gibbins ***@***.***> Sent: Thursday, January 23, 2025 10:52:56 AM To: discord/discord-api-docs ***@***.***> Cc: ThisIsSparta ***@***.***>; Author ***@***.***> Subject: Re: [discord/discord-api-docs] Subscription Workflow Tests (Discussion #7345) I figured out my issue it refuses to get the application id from the environment variables, its been a pita. I can not create a bloody test entitlement DEBUG - Response Text: {"message": "An entitlement has already been granted for this resource", "code": 40074} This is because I have to wait for a month for the test subscription to be deleted when subscribing to see how the workflow works and the json returned, basically with the limited documentation I did not fully understand the process but now I am aware. There needs to be an easy way to test the full workflow without the month wait for it to be deleted, a simple switch in the developers portal for an app to put the subscription workflow in a sandbox like when working with PayPal payment processes. This feature of the discord API/service seriously need some more work to be done on it and some documentation updates with warnings about the month wait for a subscription to be deleted. — Reply to this email directly, view it on GitHub<#7345 (reply in thread)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AKNSNMFBPCP6BG36HJYKKDL2MDCYRAVCNFSM6AAAAABVFNZ7JOVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTCOJSHAYTSMQ>. You are receiving this because you authored the thread.Message ID: ***@***.***>