Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Premium App Subscriptions #6451

Merged
merged 16 commits into from Sep 26, 2023

Conversation

colinloretz
Copy link
Contributor

@colinloretz colinloretz commented Sep 26, 2023

馃捀 Premium App Subscriptions

  • Change Log
  • Monetization Overview
  • Implementing App Subscriptions
  • Reference for SKUs and Entitlements

For feedback and bug reports, we have created a premium-apps issue label.

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
"promotion_id": null,
"type": 8,
"deleted": false,
"gift_code_flags": 0,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see promotions and this gift code flag in the payload but not the docs. Are these used at all?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not at this time. We will be taking another pass at these docs shortly and welcome feedback with a premium-apps issue or PR.

Copy link
Contributor

@Lulalaby Lulalaby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rest looks good

- App belongs to a developer team
- Team owner must be at least 18 years old
- Team must have verified emails and 2FA set up
- App uses slash commands, or has been approved for the Message Content privileged intent
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- App uses slash commands, or has been approved for the Message Content privileged intent
- App uses slash commands, or has been approved for the privileged `Message Content` intent

Mayhappens


| Field | Type | Description |
|----------------|-----------|-------------------------------------------------------------|
| id | todo | ID of SKU |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| id | todo | ID of SKU |
| id | todo | ID of SKU |

*snowflake
I won't be destroying tables this time tho

| guild_id? | snowflake | ID of the guild that is granted access to the entitlement's sku |
| application_id | snowflake | ID of the parent application |
| type | integer | [Type of entitlement](#DOCS_MONETIZATION_ENTITLEMENTS/entitlement-object-entitlement-types) |
| consumed | boolean | Not applicable for App Subscriptions. Subscriptions are not consumed and will be `false` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| consumed | boolean | Not applicable for App Subscriptions. Subscriptions are not consumed and will be `false` |

if it doesn't apply for us, it doesn't need to be documented? (at least that's the normal behavior)


## Configuring App Subscriptions

Once you have an idea what type of subscription you want to offer your app, you can create and [customize your SKU](#DOCS_MONETIZATION_SKUS/customizing-your-skus) to reflect the premium features that you are adding to your app. This is a good place to outline the benefits your users will receive from having an app subscription.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"you want to offer your app" sounds weird

| app_permissions? | string | Bitwise set of permissions the app or bot has within the channel the interaction was sent from |
| locale?\*\*\* | string | Selected [language](#DOCS_REFERENCE/locales) of the invoking user |
| guild_locale? | string | [Guild's preferred locale](#DOCS_RESOURCES_GUILD/guild-object), if invoked in a guild |
| entitlements | array of [entitlement](#DOCS_MONETIZATION_ENTITLEMENTS/entitlement-object) objects | For [monetized apps](#DOCS_MONETIZATION_OVERVIEW), any entitlements for the invoking user, representing access to premium [SKUs](#DOCS_MONETIZATION_SKUS) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sku_ids is gone then?

@colinloretz
Copy link
Contributor Author

Merging this to publish the docs. We'll be collecting feedback and doing another pass on this shortly.

mccoderpy added a commit to mccoderpy/discord.py-message-components that referenced this pull request Nov 4, 2023
shaydewael added a commit to Jupith/discord-api-docs that referenced this pull request May 14, 2024
* WIP premium apps

* Rework Overview (discord#4)

* overview page

* start app subscriptions edits

* move to monetization

* jk

* Implementing App Subscriptions

* Added query params to entitlements

* Update to Monetization Overview

* Update entitlements in interactions

* Round of small edits (discord#5)

* round of edits

* table/link

* Use Nelly sample app. Remove en-us from help center

* Added entitlements to Interaction object

* Update to Test Entitlement

* Testing your implementation

* Added emoji/icon docs

* Added Premium Apps to change log

* fix tables

* Update docs/monetization/App_Subscriptions.md

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>

---------

Co-authored-by: shay <swdewael@gmail.com>
Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants