Adds premium interaction docs #6875

goatslacker · 2024-05-16T19:43:49Z

Needs new button_styles.png image.

docs/Change_Log.md

docs/interactions/Message_Components.md

MCausc78 · 2024-05-16T19:46:51Z

docs/interactions/Receiving_and_Responding.md


 \* Only valid for [component-based](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/) interactions

 \*\* Not available for `MODAL_SUBMIT` and `PING` interactions.

-\*\*\* Not available for `APPLICATION_COMMAND_AUTOCOMPLETE` and `PING` interactions.
+\*\*\* This response type is deprecated. Learn more about [migrating to premium buttons](#DOCS_MONETIZATION_APP_SUBSCRIPTIONS/gating-premium-interactions). Not available for `APPLICATION_COMMAND_AUTOCOMPLETE` and `PING` interactions.


this may confuse developers that might think that PING/PONG/APPLICATION_COMMAND_AUTOCOMPLETE/APPLICATION_COMMAND_AUTOCOMPLETE_RESULT are deprecated. maybe place it under ****?

I think adding a fourth asterisk is a bit much but I do agree the wording is confusing. Maybe this can all look neater too since this is how it currently looks like

Maybe this can all look neater too

I'd agree that putting it in the footnote isn't optimal. Maybe put the deprecation note in a warn box instead...

this may confuse developers that might think that PING/PONG/APPLICATION_COMMAND_AUTOCOMPLETE/APPLICATION_COMMAND_AUTOCOMPLETE_RESULT are deprecated.

Made a small change that hopefully makes it more clear. be2df07

Co-authored-by: MCausc78 <mcausc78@gmail.com>

plun1331 · 2024-05-16T20:22:17Z

docs/monetization/App_Subscriptions.md

@@ -36,6 +36,33 @@ When a user subscribes to your app, there are a few things you will need to impl

 ### Gating Premium Interactions

+Each interaction payload includes an `entitlements` field containing an array of full [entitlement objects](#DOCS_MONETIZATION_ENTITLEMENTS/entitlement-object). You can use this field to determine if the user or guild is subscribed to your app. If the user or guild is not subscribed and you wish to present them with a means to do so you can use a [button](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/buttons) with a [premium style](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/button-object-button-styles) and a `sku_id` attached. You may also use these buttons to present users with options to make a [One-Time Purchase](#DOCS_MONETIZATION_ONE-TIME_PURCHASES).


This gets restated below, under Type 10 Interaction Response:

discord-api-docs/docs/monetization/App_Subscriptions.md

Lines 77 to 81 in 8588250

If someone is already subscribed, this command will show the upgrade prompt with a disabled upgrade button. In order to avoid this, your interaction handler should check to see if the user or guild has an active entitlement for your SKU.

Each interaction payload includes an `entitlements` field containing an array of full [entitlement objects](#DOCS_MONETIZATION_ENTITLEMENTS/entitlement-object).

You can use this field to determine if the user or guild is subscribed to your app.

yeah it's relevant in both cases.

yeah it's relevant in both cases.

it just seems redundant, since it's already started once here and then again under the sub header on the same page

valdotle · 2024-05-16T20:03:03Z

docs/Change_Log.md

+
+#### May 16, 2024
+
+**Premium Apps: New Premium Style for MessageComponentType.BUTTON**


Suggested change

**Premium Apps: New Premium Style for MessageComponentType.BUTTON**

**Premium Apps: New Premium Button Style**

valdotle · 2024-05-16T20:03:49Z

docs/Change_Log.md

+
+**Premium Apps: New Premium Style for MessageComponentType.BUTTON**
+
+This button is to be used with `sku_id` which points to an active SKU. This allows developers to customize their premium experience.


Suggested change

This button is to be used with `sku_id` which points to an active SKU. This allows developers to customize their premium experience.

Introducing a new `premium` [button style](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/button-object-button-styles) to be used with a `sku_id` which points to an active [SKU](#DOC_MONETIZATION_SKUS/sku-object). This allows developers to customize their premium experience.

I can commit this but we need to change an -> a.

valdotle · 2024-05-16T20:08:05Z

docs/interactions/Message_Components.md

+| label?     | string                                              | Text that appears on the button; max 80 characters                                                                                                   |
+| emoji?     | partial [emoji](#DOCS_RESOURCES_EMOJI/emoji-object) | `name`, `id`, and `animated`                                                                                                                         |
+| custom_id? | string                                              | Developer-defined identifier for the button; max 100 characters                                                                                      |
+| sku_id?    | snowflake                                           | Identifier for a purchasable SKU, only available when using [ButtonStyle.Premium](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/button-object-button-styles) |


Suggested change

| sku_id? | snowflake | Identifier for a purchasable SKU, only available when using [ButtonStyle.Premium](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/button-object-button-styles) |

| sku_id? | snowflake | Identifier for a purchasable [SKU](#DOC_MONETIZATION_SKUS/sku-object), only available when using premium-style buttons |

valdotle · 2024-05-16T20:20:21Z

docs/interactions/Receiving_and_Responding.md

+| UPDATE_MESSAGE\*                        | 7     | for components, edit the message the component was attached to                                                                                           |
+| APPLICATION_COMMAND_AUTOCOMPLETE_RESULT | 8     | respond to an autocomplete interaction with suggested choices                                                                                            |
+| MODAL\*\*                               | 9     | respond to an interaction with a popup modal                                                                                                             |
+| PREMIUM_REQUIRED\*\*\*                  | 10    | [Deprecated](#DOCS_CHANGE_LOG/premium-interactions). respond to an interaction with an upgrade button, only available for apps with monetization enabled |


Suggested change

| PREMIUM_REQUIRED\*\*\* | 10 | [Deprecated](#DOCS_CHANGE_LOG/premium-interactions). respond to an interaction with an upgrade button, only available for apps with monetization enabled |

| PREMIUM_REQUIRED\*\*\* | 10 | [**Deprecated**](#DOCS_CHANGE_LOG/premium-interactions); respond to an interaction with an upgrade button, only available for apps with monetization enabled |

MCausc78 · 2024-05-17T10:42:19Z

Why custom_id is required when using style 6? Just curious, if docs say only "sku_id" is required.

Traceback (most recent call last):
  File "/home/***/venv/lib/python3.10/site-packages/jishaku/features/python.py", line 190, in jsk_python
    async for send, result in AsyncSender(executor):  # type: ignore
  File "/home/***/venv/lib/python3.10/site-packages/jishaku/functools.py", line 124, in _internal
    value = await base.asend(self.send_value)
  File "/home/***/venv/lib/python3.10/site-packages/jishaku/repl/compilation.py", line 210, in traverse
    async for send, result in AsyncSender(func_g(*self.args)):  # type: ignore
  File "/home/***/venv/lib/python3.10/site-packages/jishaku/functools.py", line 124, in _internal
    value = await base.asend(self.send_value)
  File "<repl>", line 15, in _repl_coroutine
    await _bot.http.request(
  File "/home/***/venv/lib/python3.10/site-packages/discord/http.py", line 758, in request
    raise HTTPException(response, data)
discord.errors.HTTPException: 400 Bad Request (error code: 50035): Invalid Form Body
In components.0.components.0.sku_id: Invalid SKU
In components.0.components.0.custom_id: A custom id is required

components = [
  {
    'type': 1, 'components': [
      {
        'type': 2,
        'style': 6,
        'sku_id': '521847234246082599', # nitro sku id (maybe)
        'label': 'wdhsjshjs',
      }
    ]
  }
]

await _bot.http.request(
  discord.http.Route('POST',
    '/channels/{channel_id}/messages',
    channel_id=_channel.id
  ), json={
  'content': 'Hello world',
  'components': components
})

(Unverified bot)

advaith1 · 2024-05-28T21:59:55Z

Why are custom labels not supported for premium buttons? That's unfortunate for bots that want to provide multiple options in the response

Shuu-37 · 2024-05-28T22:02:18Z

Why are custom labels not supported for premium buttons? That's unfortunate for bots that want to provide multiple options in the response

They can still have multiple buttons in a response. But we want clarity in each of the premium buttons and requiring sku_name & price is the best path forward right now. It's possible we can open this up in the future to not require sku name & price.

docs/interactions/Message_Components.md

Co-authored-by: codershiba <155646804+codershiba@users.noreply.github.com>

wasdennnoch · 2024-06-09T09:19:18Z

docs/interactions/Message_Components.md

+- 34 characters max with icon or emoji
+- 38 characters max without icon or emoji


Consistency: All the other list items end with a dot.

Suggested change

- 34 characters max with icon or emoji

- 38 characters max without icon or emoji

- 34 characters max with icon or emoji.

- 38 characters max without icon or emoji.

advaith1 · 2024-06-09T09:56:38Z

docs/interactions/Message_Components.md

@@ -115,11 +118,46 @@ Buttons come in a variety of styles to convey different types of actions. These
 | Success   | 3     | green                    | `custom_id`    |
 | Danger    | 4     | red                      | `custom_id`    |
 | Link      | 5     | grey, navigates to a URL | `url`          |
+| Premium   | 6     | gradient                 | `sku_id`       |


Adds premium interaction docs

ef23d7c

goatslacker added the not released This issue or PR is referencing a change that is not yet widely released and/or subject to change. label May 16, 2024

goatslacker requested a review from colinloretz May 16, 2024 19:43

goatslacker assigned colinloretz May 16, 2024

goatslacker commented May 16, 2024

View reviewed changes

docs/Change_Log.md Outdated Show resolved Hide resolved

MCausc78 reviewed May 16, 2024

View reviewed changes

Update docs/interactions/Message_Components.md

226dacb

Co-authored-by: MCausc78 <mcausc78@gmail.com>

plun1331 mentioned this pull request May 16, 2024

feat: update monetization Pycord-Development/pycord#2438

Draft

9 tasks

goatslacker added 2 commits May 16, 2024 15:58

fix tables

2f89235

Revert rm whitespace

8588250

plun1331 reviewed May 16, 2024

View reviewed changes

valdotle reviewed May 16, 2024

View reviewed changes

MCausc78 mentioned this pull request May 16, 2024

Add ButtonStyle.premium and deprecate InteractionCallbackType.premiumRequired nyxx-discord/nyxx#660

Open

7 tasks

goatslacker mentioned this pull request May 16, 2024

New premium button style discord/discord-interactions-js#55

Open

ghost mentioned this pull request May 17, 2024

feat: Premium button type discordjs/discord-api-types#987

Closed

sebm253 mentioned this pull request May 17, 2024

Add ButtonStylePremium disgoorg/disgo#359

Draft

1 task

DA-344 mentioned this pull request May 25, 2024

Add ButtonStyle.premium Rapptz/discord.py#9845

Merged

6 tasks

disallows customizable label for premium buttons

be2df07

ghost reviewed May 29, 2024

View reviewed changes

docs/interactions/Message_Components.md Outdated Show resolved Hide resolved

goatslacker and others added 2 commits May 29, 2024 17:52

Update docs/interactions/Message_Components.md

9453add

Co-authored-by: codershiba <155646804+codershiba@users.noreply.github.com>

add some button design guidelines

d247d1d

wasdennnoch reviewed Jun 9, 2024

View reviewed changes

advaith1 reviewed Jun 9, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds premium interaction docs #6875

Adds premium interaction docs #6875

goatslacker commented May 16, 2024

MCausc78 May 16, 2024

goatslacker May 16, 2024

valdotle May 16, 2024

goatslacker May 28, 2024

plun1331 May 16, 2024

goatslacker May 16, 2024

plun1331 May 17, 2024

valdotle May 16, 2024

valdotle May 16, 2024 •

edited

goatslacker May 28, 2024

valdotle May 16, 2024

valdotle May 16, 2024

MCausc78 commented May 17, 2024

advaith1 commented May 28, 2024

Shuu-37 commented May 28, 2024

wasdennnoch Jun 9, 2024

advaith1 Jun 9, 2024

		@@ -36,6 +36,33 @@ When a user subscribes to your app, there are a few things you will need to impl

		### Gating Premium Interactions

		Each interaction payload includes an `entitlements` field containing an array of full [entitlement objects](#DOCS_MONETIZATION_ENTITLEMENTS/entitlement-object). You can use this field to determine if the user or guild is subscribed to your app. If the user or guild is not subscribed and you wish to present them with a means to do so you can use a [button](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/buttons) with a [premium style](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/button-object-button-styles) and a `sku_id` attached. You may also use these buttons to present users with options to make a [One-Time Purchase](#DOCS_MONETIZATION_ONE-TIME_PURCHASES).

	If someone is already subscribed, this command will show the upgrade prompt with a disabled upgrade button. In order to avoid this, your interaction handler should check to see if the user or guild has an active entitlement for your SKU.

	Each interaction payload includes an `entitlements` field containing an array of full [entitlement objects](#DOCS_MONETIZATION_ENTITLEMENTS/entitlement-object).

	You can use this field to determine if the user or guild is subscribed to your app.


		#### May 16, 2024

		Premium Apps: New Premium Style for MessageComponentType.BUTTON

	Premium Apps: New Premium Style for MessageComponentType.BUTTON
	Premium Apps: New Premium Button Style


		Premium Apps: New Premium Style for MessageComponentType.BUTTON

		This button is to be used with `sku_id` which points to an active SKU. This allows developers to customize their premium experience.

	This button is to be used with `sku_id` which points to an active SKU. This allows developers to customize their premium experience.
	Introducing a new `premium` [button style](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/button-object-button-styles) to be used with a `sku_id` which points to an active [SKU](#DOC_MONETIZATION_SKUS/sku-object). This allows developers to customize their premium experience.

	\| sku_id? \| snowflake \| Identifier for a purchasable SKU, only available when using [ButtonStyle.Premium](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/button-object-button-styles) \|
	\| sku_id? \| snowflake \| Identifier for a purchasable [SKU](#DOC_MONETIZATION_SKUS/sku-object), only available when using premium-style buttons \|

	\| PREMIUM_REQUIRED\\\* \| 10 \| [Deprecated](#DOCS_CHANGE_LOG/premium-interactions). respond to an interaction with an upgrade button, only available for apps with monetization enabled \|
	\| PREMIUM_REQUIRED\\\* \| 10 \| [Deprecated](#DOCS_CHANGE_LOG/premium-interactions); respond to an interaction with an upgrade button, only available for apps with monetization enabled \|

		- 34 characters max with icon or emoji
		- 38 characters max without icon or emoji

	\| Premium \| 6 \| gradient \| `sku_id` \|
	\| Premium \| 6 \| blurple \| `sku_id` \|

Adds premium interaction docs #6875

Are you sure you want to change the base?

Adds premium interaction docs #6875

Conversation

goatslacker commented May 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

valdotle May 16, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MCausc78 commented May 17, 2024

advaith1 commented May 28, 2024

Shuu-37 commented May 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

valdotle May 16, 2024 •

edited