Collectibles are SKUs representing digital items that users typically purchase in the Discord Shop to customize their profiles and avatars.
Field Type Description sku_id snowflake The SKU ID of the collectible product store_listing_id snowflake The store listing ID associated with the collectible product type integer The type of collectible bundled_products? array[collectible product object] The bundled products included in the collectible product category_sku_id snowflake The category SKU ID of the collectible product google_sku_ids? map[integer, string] The Google SKU IDs for the collectible per purchase type items 3 array[collectible item object] The items included in the collectible product name string The name of the collectible product premium_type integer The premium type required to purchase the collectible product prices? map[integer, subscription prices object] The prices for the collectible per purchase type styles collectible styles objectThe colors to use in the client summary string A description of the collectible product unpublished_at ?ISO8601 timestamp When the collectible product should be unpublished base_variant_name? string The name of the base variant of the collectible product base_variant_sku_id? snowflake The SKU ID of the base variant of the collectible product expires_at? 2 ?ISO8601 timestamp When the collectible product expires purchase_type? 2 integer The purchase type of the collectible product purchased_at? 2 ISO8601 timestamp When the collectible product was purchased variant_label? string The label for the variant of the collectible product variant_value? string The hex value of the color for the variant of the collectible product variants? 1 arraycollectible product object] The variants of the collectible product
1 Only included when is set to , otherwise each variant will be returned as a separate product.
2 Only present on collectibles purchases endpoint.
3 If the product type is , will be empty and instead should be used.
Field Type Description background_colors array[integer] An array of background colors button_colors array[integer] An array of button colors confetti_colors array[integer] An array of confetti colors
Value Name Description 1 PURCHASED Purchased normally 5 PROMOTIONAL Received through a promotional event 6 GIFTED Received as a gift 7 SUBSCRIPTION Claimed with a premium subscription 10 QUEST Received from a quest
Value Name Description 0 AVATAR_DECORATION An avatar decoration 1 PROFILE_EFFECT A profile effect 2 NAMEPLATE A nameplate 1000 BUNDLE A bundle of collectibles 2000 VARIANTS_GROUP A group of variants 3000 EXTERNAL_SKU A non-collectible SKU (e.g. fractional premium)
Field Type Description type integer The type of collectible id snowflake The ID of the avatar decoration sku_id snowflake The SKU ID of the avatar decoration asset string The asset hash of the avatar decoration assets item assets objectThe URLs for the static and animated images of the avatar decoration label string The avatar decoration accessibility description
Field Type Description type integer The type of collectible id string The ID of the profile effect sku_id string The ID of the profile effect SKU title string The title of the profile effect description string The description of the profile effect accessibilityLabel string An accessible description of the profile effect animationType integer The type of animation used by the profile effect thumbnailPreviewSrc string The URL of the profile effect's thumbnail preview image (in APNG format) reducedMotionSrc string A URL of the profile effect with reduced motion (in APNG format) staticFrameSrc string The URL of the static frame of the profile effect (in PNG format) effects array[profile effect animation object] The animation frames for the profile effect
Field Type Description src string The URL of the animation image (in APNG format) loop boolean Whether the animation frame should loop height integer The height of the animation image width integer The width of the animation image duration integer The duration of the animation frame (in milliseconds) start integer The start time of the animation frame (in milliseconds) loopDelay integer The delay between loops of the animation frame (in milliseconds) position profile effect position objectThe position of the animation frame zIndex integer The z-index of the animation frame randomizedSources array[profile effect source object] The sources to randomize the from
Field Type Description x integer The x-coordinate of the animation frame y integer The y-coordinate of the animation frame
Field Type Description src string The URL of the animation image (in APNG format)
Value Name Description 0 UNSPECIFIED The animation type is unspecified 1 PERSISTENT The animation type is persistent 2 INTERMITTENT The animation type is intermittent
Field Type Description type integer The type of collectible id snowflake The ID of the nameplate sku_id snowflake The SKU ID of the nameplate palette string The nameplate's color palette asset string The nameplate asset path assets item assets objectThe URLs for the static and animated images of the nameplate label string The nameplate accessibility description
Value Description none None crimson Crimson berry Berry sky Sky teal Teal forest Forest bubble_gum BubbleGum violet Violet cobalt Cobalt clover Clover lemon Lemon white White
Field Type Description static_image_url string The URL for the static image of the collectible animated_image_url string The URL for the animated image of the collectible (in APNG format) video_url? string The URL for the video of the collectible
Field Type Description sku_id snowflake The SKU ID of the collectible category store_listing_id snowflake The store listing ID associated with the collectible category banner_text_color? string The color of the banner text as a hexadecimal color string catalog_banner_asset? banner asset objectThe catalog banner asset featured_block_body? string The body text for the featured block featured_block_url? string The URL of the featured block image hero_banner_asset? banner asset objectThe hero banner asset hero_banner_display_config? asset config objectThe display configuration for the hero banner hero_block_title? string The title text for the hero block hero_logo_display_config? asset config objectThe display configuration for the hero logo hero_logo_url? string The URL of the hero logo image hero_ranking ?array[snowflake] The popularity ranking of SKU IDs within the collectible category hero_rive_url? string The URL of the Rive hero animation logo_url string The URL of the logo image mobile_banner_url? string The URL of the mobile banner image mobile_bg_url? string The URL of the mobile background image mobile_hero_block_title? string The title text for the mobile hero block mobile_products_title? string The title text for the mobile products section mobile_summary string The summary text for the mobile products section name string The name of the collectible category pdp_bg_url string The URL of the product display page background image products array[collectible product object] The list of products in the collectible category styles collectible styles objectThe colors to use in the client summary string A description of the collectible category unpublished_at ?ISO8601 timestamp The time at which the collectible category should be unpublished wide_banner_asset? asset config objectThe wide banner asset config wide_banner_body? string The body text for the wide banner wide_banner_title? string The title text for the wide banner
Field Type Description animated ?string The URL of the animated image (in APNG format) static string The URL of the static image
Field Type Description background_style ?string The CSS the web client should use desktop_max_height? ?integer Max height of the banner on desktop mobile_max_height? ?integer Max height of the banner on mobile responsive ?boolean Whether the banner is responsive
Field Type Description type integer The shop block type category_sku_id snowflake The collectible category SKU ID category_store_listing_id snowflake The collectible category store listing ID banner_asset asset config objectThe banner asset banner_display_config banner asset objectThe display configuration banner_text_color? string The hex color code for the banner text hero_logo_url string The URL of the hero logo image hero_rive_url? string The URL of the hero Rive animation logo_display_config banner asset objectThe shop block logo display config logo_url string The URL of the hero logo image name string The name of the shop block mobile_title? string The title to be displayed on mobile devices mobile_summary? string The summary to be displayed on mobile devices mobile_products_title? string The products title to be displayed on mobile devices mobile_hero_url? string The URL of the mobile hero banner image mobile_hero_animated_url? string The URL of the mobile animated hero banner image ranked_sku_ids array[snowflake] The SKU IDs ranked by popularity in the collectible category summary string A description of the collectible category unpublished_at ?ISO8601 timestamp When the collectible category should be unpublished
Field Type Description subblocks arraysubblock object] The list of sub-blocks in the featured shop block type integer The shop block type
Field Type Description type integer The subblock type category_store_listing_id snowflake The collectible category store listing ID asset_url string The URL of the shop block asset banner_text_color ?string The hex color code of the banner text banner_url string The URL of the banner image body_text ?string The body text of the shop block name string The name of the shop block unpublished_at ?ISO8601 timestamp When the collectible category should be unpublished
Value Name Description 0 CATEGORY A category subblock
Field Type Description ranked_sku_ids array[snowflake] All SKU IDs ranked by popularity sorted_sku_ids sorted SKU IDs objectThe sorted SKU IDs type integer The shop block type
Field Type Description popular array[snowflake] The SKU IDs sorted by popularity recommended array[snowflake] The SKU IDs sorted by recommendation
Field Type Description type integer The shop block type category_store_listing_id snowflake The collectible category store listing ID banner_asset asset config objectThe banner asset logo_url string The URL of the wide banner logo image title string The title of the wide banner body string The body text of the wide banner banner_text_color ?string The hex color code of the banner text disable_cta boolean Whether to disable the CTA for the wide banner cta_text string The CTA text for the wide banner cta_route string The CTA route for the wide banner is_dismissible boolean Whether the wide banner is dismissible dismissible_content_version integer The version of the dismissible content wide_banner_url string The URL of the wide banner image wide_banner_animated_url? string The URL of the animated wide banner image
Field Type Description type integer The shop block type title string The title of the countdown timer body string The body text of the countdown timer banner_url string The URL of the countdown timer banner end_time ISO8601 timestamp The end time of the countdown timer text_color string The hex color code of the text
Field Type Description type integer The shop block type title string The title of the immersive banner body string The body text of the immersive banner help_center_url string The URL to the help center article text_color string The hex color code of the text end_time ?ISO8601 timestamp The end time of the immersive banner banner_asset asset config objectThe banner asset
Field Type Description type integer The shop block type category_sku_id? snowflake The collectible category SKU ID category_store_listing_id snowflake The collectible category store listing ID name string The name of the shop block summary string A description of the collectible category banner_asset asset config objectThe banner asset logo_url string The URL of the hero logo image title string The title of the reward hero shop block banner_text_color? string The hex color code for the banner text banner_display_config banner asset objectThe display configuration hero_rive_url? string The URL of the hero Rive animation logo_display_config banner asset objectThe shop block logo display config mobile_title? string The title to be displayed on mobile devices mobile_summary? string The summary to be displayed on mobile devices mobile_products_title? string The products title to be displayed on mobile devices hero_banner_url string The URL of the hero banner image hero_banner_animated_url string The URL of the hero animated banner image hero_logo_url string The URL of the hero logo image mobile_hero_url? string The URL of the mobile hero banner image mobile_hero_animated_url? string The URL of the mobile animated hero banner image ranked_sku_ids array[snowflake] The SKU IDs ranked by popularity in the collectible category unpublished_at ?ISO8601 timestamp When the collectible category should be unpublished reward_sku_id snowflake The SKU ID of the reward collectible
Field Type Description type integer The collectibles marketing type version integer The version of the coachtip title string The title of the coachtip body string The body text of the coachtip avatar string The URL of the coachtip avatar decorations array[string] The avatar decoration asset hashes dismissible_content integer The ID of the dismissible content ref_target_background target background objectThe target background configuration
Field Type Description light ?string The URL of the light mode image dark ?string The URL of the dark mode image
Field Type Description type integer The collectibles marketing type version integer The version of the badge dismissible_content integer The ID of the dismissible content
Field Type Description type integer The collectibles marketing type version integer The version of the banner title string The title of the banner body string The body text of the banner asset string The URL of the banner image popout_asset string The URL of the banner popout image revert_text_color? boolean Whether to revert the text color on the banner
Field Type Description type integer The collectibles marketing type title string The title of the coachmark body string The body text of the coachmark asset_dark string The URL of the dark mode coachmark image asset_light string The URL of the light mode coachmark image version integer The version of the coachmark ref_target_background object The target background configuration
GET/collectibles-categoriesTest
Returns the list of collectible categories objects available in the store.
Field Type Description country_code? string The user's ISO 3166-1 alpha-2 country code include_bundles? boolean Whether to include bundles include_nameplates_on_mobile? boolean Whether to include nameplates on mobile include_unpublished? 1 boolean Whether to include unpublished categories no_cache? 1 boolean Whether to bypass the cache payment_gateway? integer The payment gateway of the payment source skip_num_categories? 1 integer The number of categories to skip variants_return_style? integer The variant style to return
1 Only usable by Discord employees.
Value Name Description 1 INDIVIDUAL_PRODUCTS Variants should be returned as individual products 2 VARIANTS_GROUP Variants should be returned as a group
GET/collectibles-categories/v2Test
Returns the collectible categories available in the store.
Field Type Description country_code? string The user's ISO 3166-1 alpha-2 country code include_bundles? boolean Whether to include bundles include_nameplates_on_mobile? boolean Whether to include nameplates on mobile include_unpublished? 1 boolean Whether to include unpublished categories no_cache? 1 boolean Whether to bypass the cache payment_gateway? integer The payment gateway of the payment source skip_num_categories? 1 integer The number of categories to skip variants_return_style? integer The variant style to return
1 Only usable by Discord employees.
Field Type Description amount integer How much the discount is discount_id snowflake The discount ID expires_at ?ISO8601 timestamp When the discount expires
GET/collectibles-shopTest
Returns the list of collectible categories available in the store.
Field Type Description country_code? string The user's ISO 3166-1 alpha-2 country code tab? string The tab to retrieve shop_home_config? string The shop home configuration override include_bundles? boolean Whether to include bundles include_dynamic_blocks? boolean Whether to include dynamic blocks include_nameplates_on_mobile? boolean Whether to include nameplates on mobile include_unpublished? 1 boolean Whether to include unpublished categories no_cache? 1 boolean Whether to bypass the cache payment_gateway? integer The payment gateway of the payment source skip_num_categories? 1 integer The number of categories to skip variants_return_style? integer The variant style to return
1 Only usable by Discord employees.
Value Description home The home tab catalog The catalog tab orbs The orbs tab
Value Description default The default shop home configuration default_with_orb_shelf The default shop home configuration with orb shelf orb_tab The orb tab shop home configuration summer_sale_takeover The summer sale takeover shop home configuration
Returns the collectible SKUs that match the given query.
Field Type Description item_types? array[string] The item types to search for colors? array[string] The products to search for that have the color themes? array[string] The products with the specified theme to search for orbs_eligible? boolean Whether you can purchase the products with orbs offset? integer Number of products to skip before returning results limit? integer Max amount of SKU IDs to return (max 100, default 20) sort_type? string How should the results be sorted sort_direction? string The direction to sort the results in ( or , default ) search? string The query to match (max 256 characters)
Value Description AVATAR_DECORATION An avatar decoration product PROFILE_EFFECT A profile effect product NAMEPLATE A nameplate product BUNDLE A bundle of collectible products
Value Description COLLECTIBLES_THEME_ANIME Products with an anime theme COLLECTIBLES_THEME_GAMING Products with a gaming theme COLLECTIBLES_THEME_CUTE_COZY Products with a cute and cozy theme COLLECTIBLES_THEME_FOOD_DRINKS Products with a food and drinks theme COLLECTIBLES_THEME_ANIMALS_PETS Products with an animals and pets theme COLLECTIBLES_THEME_MOVIES_TV_SHOWS Products with a movies and TV shows theme COLLECTIBLES_THEME_FANTASY Products with a fantasy theme COLLECTIBLES_THEME_DARK_MOODY Products with a dark and moody theme COLLECTIBLES_THEME_NATURE Products with a nature theme COLLECTIBLES_THEME_SCI_FI Products with a sci-fi theme
Value Description COLLECTIBLES_COLOR_BLUE Blue color COLLECTIBLES_COLOR_GREEN Green color COLLECTIBLES_COLOR_PINK Pink color COLLECTIBLES_COLOR_RED Red color COLLECTIBLES_COLOR_YELLOW Yellow color COLLECTIBLES_COLOR_ORANGE Orange color COLLECTIBLES_COLOR_PURPLE Purple color COLLECTIBLES_COLOR_BROWN Brown color COLLECTIBLES_COLOR_BLACK Black color COLLECTIBLES_COLOR_WHITE White color
Value Description relevance Sort by relevance price Sort by price alphabetical Sort alphabetically recency Sort by recency popularity Sort by popularity
Field Type Description pagination pagination objectThe pagination information skus array[snowflake] The list of matching SKU IDs
Field Type Description offset integer The offset of the current page limit integer The limit of items per page total integer The total number of items has_more boolean Whether there are more pages
GET/collectibles-products/{sku.id}Test
Returns the collectible product for a given SKU ID.
Field Type Description country_code? string The user's ISO 3166-1 alpha-2 country code include_bundles? boolean Whether to include bundles variants_return_style? integer The variant style to return
GET/users/@me/collectibles-purchasesTest
Returns the list of collectible products owned by the current user.
Field Type Description variants_return_style? integer The variant style to return
GET/user-profile-effectsTest
Returns the list of profile effects available to display.
Field Type Description locale? string The user's locale with_unpublished? 1 boolean Whether to include unpublished profile effects
1 Only usable by Discord employees.
GET/users/@me/valid-collectibles-gift-recipientTest
Returns a gift eligibility object for the given user and collectible SKU ID.
Field Type Description recipient_id snowflake The ID of the user to check for gift eligibility sku_id snowflake The SKU ID of the collectible to gift
Field Type Description valid boolean Whether the recipient is eligible to receive the gift
GET/users/@me/valid-collectibles-gift-recipients-batchTest
Returns a mapping of SKU IDs to gift eligibility object for the given user and collectible SKU IDs.
Field Type Description recipient_id snowflake The ID of the user to check for gift eligibility sku_ids array[snowflake] The SKU IDs of the collectibles to gift
PUT/users/@me/claim-premium-collectibles-productTest
Claims a collectible SKU provided for free to premium users. Returns a list of collectible products objects owned by the current user if the user hasn't claimed the product yet, otherwise returns a 204 empty response.
Field Type Description sku_id snowflake The SKU ID of the premium collectible product to claim
GET/users/@me/collectibles-marketingTest
Returns collectibles marketing information for the current user.
Field Type Description platform integer The platform to get marketing information for
Value Name Description 0 DESKTOP Desktop 1 MOBILE Mobile