Monetization

Look up and manage the bot's SKUs, entitlements and subscriptions.

Fetch application SKUs

Fetches all SKUs for the bot's application.

Outputs

Name	Type	Details
SKUs	List of SKU	All SKUs of the application.

Fetch SKU by ID

Fetches a single SKU by ID.

Inputs

Name	Type	Required	Details
ID	Discord ID	Yes	The Discord ID of the SKU.

Outputs

Name	Type	Details
SKU	SKU	The SKU, or empty if not found. May be empty.

Fetch application entitlements

Fetches entitlements for the application, optionally filtered by user, SKU, or server.

Inputs

Name	Type	Required	Details
User ID	Discord ID	No	Only return entitlements owned by this user.
SKU IDs	List of Discord ID	No	Only return entitlements for these SKUs.
Server ID	Discord ID	No	Only return entitlements owned by this server.
Exclude Ended	Yes/No	Yes	Whether to omit entitlements that have already ended. Default: No.
Exclude Deleted	Yes/No	Yes	Whether to omit deleted entitlements. Default: Yes.
Limit	Whole number	Yes	Maximum number of entitlements to return (1-100). Value: 1 to 100. Default: 100.

Outputs

Name	Type	Details
Entitlements	List of Entitlement	The matched entitlements.

Fetch entitlement by ID

Fetches a single entitlement by its Discord ID.

Inputs

Name	Type	Required	Details
ID	Discord ID	Yes	The ID of the entitlement to fetch.

Outputs

Name	Type	Details
Entitlement	Entitlement	The entitlement, or empty if not found. May be empty.

Create test entitlement

Creates a test entitlement for an SKU, useful when testing premium features in development.

Inputs

Name	Type	Required	Details
SKU ID	Discord ID	Yes	ID of the SKU to grant the entitlement for.
Owner Type	Entitlement owner type	Yes	Whether the entitlement is owned by a user or a server.
Owner ID	Discord ID	Yes	ID of the owning user or server.

Outputs

Name	Type	Details
Entitlement	Entitlement	The newly created test entitlement.

Delete test entitlement

Deletes a test entitlement previously created via the test endpoint.

Inputs

Name	Type	Required	Details
Entitlement	Entitlement	Yes	The test entitlement to delete.

Consume entitlement

Marks a one-time consumable entitlement as consumed.

Inputs

Name	Type	Required	Details
Entitlement	Entitlement	Yes	The consumable entitlement to consume.

Fetch SKU subscriptions

Fetches subscriptions for an SKU, optionally filtered by user and paginated.

Inputs

Name	Type	Required	Details
SKU ID	Discord ID	Yes	The SKU whose subscriptions should be fetched.
User ID	Discord ID	No	Only return subscriptions of this user.
Before	Discord ID	No	Return subscriptions whose IDs come before this Discord ID.
After	Discord ID	No	Return subscriptions whose IDs come after this Discord ID.
Limit	Whole number	Yes	Maximum number of subscriptions to return (1-100). Value: 1 to 100. Default: 50.

Outputs

Name	Type	Details
Subscriptions	List of Subscription	The matched subscriptions.

Fetch SKU subscription by ID

Fetches a single subscription for an SKU by its ID.

Inputs

Name	Type	Required	Details
SKU ID	Discord ID	Yes	The SKU the subscription belongs to.
Subscription ID	Discord ID	Yes	The ID of the subscription.

Outputs

Name	Type	Details
Subscription	Subscription	The subscription, or empty if not found. May be empty.