Discord store resources have a long and convoluted history.
The store was originally built to support game developers selling games and in-game items on Discord, as well as GameSDK features.
While this was deprecated soon after, the store infrastructure remained in place, fully functional.
It was then used internally to power the Discord Nitro subscription service, as well as other ventures such as the now-defunct paid sticker packs.
Now, it has been repurposed to support guild and application monetization features, such as guild products and application subscriptions.
As Discord has returned to gaming with the release of the Social SDK, it is now again being used to support sales of in-game items.
While the store infrastructure is still in use, most of the new features being built with it offer newer APIs to manage and interact with them.
Certain new features may require using these new APIs to function properly, and may not be fully compatible with the older store APIs, even though
they are using SKUs and store listings under the hood.
A purchasable item or group of items in Discord.
SKU objects can either be localized or unlocalized. Localized SKUs only serialize strings and pricing for the user's location, while unlocalized SKUs serialize all strings and pricing for all locales.
All objects serialized in the SKU inherit this behavior.
Field Type Description id snowflake The ID of the SKU type integer The type of SKU application_id snowflake The ID of the application the SKU belongs to application? partial application The application the SKU belongs to product_line ?integer The product line the SKU belongs to product_id? snowflake The ID of the storefront product the SKU is for flags integer The SKU flags name localized string The name of the SKU summary? localized string The summary of the SKU description? localized string The description of the SKU legal_notice? localized string The legal notice for the SKU slug string The URL slug of the SKU thumbnail_asset_id? snowflake The ID of the store asset for the SKU's thumbnail dependent_sku_id? ?snowflake The ID of the prerequisite required to buy this SKU bundled_skus? array[SKU object] The SKUs that are included when purchasing this SKU bundled_sku_ids? array[snowflake] The IDs of the SKUs that are included when purchasing this SKU access_type integer The access level of the SKU manifest_labels? ?array[snowflake] The IDs of the manifest labels associated with the SKU features array[integer] The features of the SKU locales? array[string] The locales the SKU is available in (default ) genres? array[integer] The genres of the SKU available_regions? array[string] The ISO 3166-1 alpha-2 country codes where the SKU is available content_rating? 1 content rating objectThe content rating of the SKU content_rating_agency? 1 integer The agency that assigned the content rating content_ratings? 2 map[integer, content rating object] The content ratings of the SKU per agency system_requirements? map[integer, system requirements object] The system requirements for each operating system the SKU supports price? 1 SKU price objectThe price of the SKU price_tier? 2 integer The base price of the SKU price? 2 map[string, integer] Localized pricing overrides per lower-cased ISO 4217 currency code sale_price_tier? 2 integer The sale price of the SKU sale_price? 2 map[string, integer] Localized sale pricing overrides per lower-cased ISO 4217 currency code created_at 3 ISO8601 datetime When the SKU was created updated_at 3 ISO8601 datetime When the SKU was last updated release_date? ISO8601 date When the SKU will be released preorder_approximate_release_date? string When the developer has indicated the SKU will be released for preorders preorder_released_at? ISO8601 datetime When the SKU was released for preorders external_purchase_url? string An external URL to purchase the SKU external_sku_strategies? (deprecated) map[integer, external SKU strategy object] Sale strategies per payment gateway supported eligible_payment_gateways? array[integer] The payment gateways the SKU can be purchased with premium boolean Whether the SKU is a premium user perk show_age_gate boolean Whether to show an age gate when purchasing the SKU restricted? 1 boolean Whether the SKU is restricted in the user's region exclusive? boolean Whether the SKU is exclusively available on Discord deleted? boolean Whether the SKU has been soft-deleted tenant_metadata? tenant metadata objectTenant metadata for the SKU powerup_metadata? guild powerup metadata objectGuild powerup metadata for the SKU orbs_reward? integer The amount of Orbs the SKU grants
1 Only included for localized SKUs.
2 Only included for unlocalized SKUs.
3 Values have only been tracked since . Earlier SKUs will have this field set to this timestamp. See the snowflake format documentation for a more accurate creation timestamp.
Value Name Description 1 DURABLE_PRIMARY Primary durable item 2 DURABLE Durable item 3 CONSUMABLE Consumable item 4 BUNDLE Bundle of items 5 SUBSCRIPTION Subscription item 6 SUBSCRIPTION_GROUP Group of subscription items
Value Name Description 1 PREMIUM Premium (Nitro) subscription 2 PREMIUM_GUILD Premium guild (boosting) subscription 3 ACTIVITY_IAP Embedded activity in-app purchase 4 GUILD_ROLE Guild role subscription or ticketed event 5 GUILD_PRODUCT Guild product 6 APPLICATION Application item 7 COLLECTIBLES Discord collectible 9 QUEST_IN_GAME_REWARD In-game quest reward 10 QUEST_REWARD_CODE Quest reward code 11 FRACTIONAL_PREMIUM Fractional premium subscription 12 VIRTUAL_CURRENCY Virtual currency (Orbs) 13 GUILD_POWERUP Guild powerup 14 SOCIAL_LAYER_GAME_ITEM Social SDK game item
Value Name Description 1 << 0 PREMIUM_PURCHASE SKU is available for free to premium users 1 << 1 HAS_FREE_PREMIUM_CONTENT SKU has free content for premium users 1 << 2 AVAILABLE SKU is available for purchase 1 << 3 PREMIUM_AND_DISTRIBUTION SKU is available for free to premium users and purchasable normally 1 << 4 STICKER SKU is a paid sticker pack 1 << 5 GUILD_ROLE SKU is a guild role subscription or ticketed event 1 << 6 AVAILABLE_FOR_SUBSCRIPTION_GIFTING SKU is a giftable Discord premium subscription 1 << 7 APPLICATION_GUILD_SUBSCRIPTION SKU is an application subscription for guilds 1 << 8 APPLICATION_USER_SUBSCRIPTION SKU is an application subscription for users 1 << 9 CREATOR_MONETIZATION SKU is a guild creator monetization product 1 << 10 GUILD_PRODUCT SKU is a guild product 1 << 11 AVAILABLE_FOR_APPLICATION_GIFTING SKU is a giftable application product
Value Name Description 1 FULL SKU is fully accessible 2 EARLY_ACCESS SKU is in early access 3VIP_ACCESSSKU has limited availability
Value Name Description 1 SINGLE_PLAYER Single player game 2 ONLINE_MULTIPLAYER Online multiplayer game 3 LOCAL_MULTIPLAYER Local multiplayer game 4 PVP Player versus player game 5 LOCAL_COOP Local cooperative multiplayer 6 CROSS_PLATFORM Cross-platform play supported 7 RICH_PRESENCE Rich presence integration 8 DISCORD_GAME_INVITES Discord game invites supported 9 SPECTATOR_MODE Spectator mode supported 10 CONTROLLER_SUPPORT Controller support 11 CLOUD_SAVES Cloud saves supported 12 ONLINE_COOP Online cooperative multiplayer 13 SECURE_NETWORKING Secure networking supported
Value Name Description 1 ACTION Action 2 ACTION_RPG Action RPG 3 BRAWLER Brawler 4 HACK_AND_SLASH Hack and Slash 5 PLATFORMER Platformer 6 STEALTH Stealth 7 SURVIVAL Survival 8 ADVENTURE Adventure 9 ACTION_ADVENTURE Action Adventure 10 METROIDVANIA Metroidvania 11 OPEN_WORLD Open World 12 PSYCHOLOGICAL_HORROR Psychological Horror 13 SANDBOX Sandbox 14 SURVIVAL_HORROR Survival Horror 15 VISUAL_NOVEL Visual Novel 16 DRIVING_RACING Driving / Racing 17 VEHICULAR_COMBAT Vehicular Combat 18 MASSIVELY_MULTIPLAYER Massively Multiplayer 19 MMORPG MMORPG 20 ROLE_PLAYING Role-Playing 21 DUNGEON_CRAWLER Dungeon Crawler 22 ROGUELIKE Roguelike 23 SHOOTER Shooter 24 LIGHT_GUN Light Gun 25 SHOOT_EM_UP Shoot 'Em Up 26 FPS First-Person Shooter 27 DUAL_JOYSTICK_SHOOTER Dual-Joystick Shooter 28 SIMULATION Simulation 29 FLIGHT_SIMULATOR Flight Simulator 30 TRAIN_SIMULATOR Train Simulator 31 LIFE_SIMULATOR Life Simulator 32 FISHING Fishing 33 SPORTS Sports 34 BASEBALL Baseball 35 BASKETBALL Basketball 36 BILLIARDS Billiards 37 BOWLING Bowling 38 BOXING Boxing 39 FOOTBALL Football 40 GOLF Golf 41 HOCKEY Hockey 42 SKATEBOARDING_SKATING Skateboarding / Skating 43 SNOWBOARDING_SKIING Snowboarding / Skiing 44 SOCCER Soccer 45 TRACK_FIELD Track & Field 46 SURFING_WAKEBOARDING Surfing / Wakeboarding 47 WRESTLING Wrestling 48 STRATEGY Strategy 49 FOUR_X 4X (explore, expand, exploit, exterminate) 50 ARTILLERY Artillery 51 RTS Real-Time Strategy 52 TOWER_DEFENSE Tower Defense 53 TURN_BASED_STRATEGY Turn-Based Strategy 54 WARGAME Wargame 55 MOBA Multiplayer Online Battle Arena 56 FIGHTING Fighting 57 PUZZLE Puzzle 58 CARD_GAME Card Game 59 EDUCATION Education 60 FITNESS Fitness 61 GAMBLING Gambling 62 MUSIC_RHYTHM Music / Rhythm 63 PARTY_MINI_GAME Party / Mini Game 64 PINBALL Pinball 65 TRIVIA_BOARD_GAME Trivia / Board Game 66 TACTICAL Tactical 67 INDIE Indie 68 ARCADE Arcade 69 POINT_AND_CLICK Point-and-Click
Value Name Description 1 EVERYONE Suitable for all ages 2 EVERYONE_TEN_PLUS Suitable for ages 10 and up 3 TEEN Suitable for ages 13 and up 4 MATURE Suitable for ages 17 and up 5 ADULTS_ONLY Suitable for ages 18 and up 6 RATING_PENDING Rating is pending
Value Name Description 1 THREE Suitable for all ages 2 SEVEN Suitable for ages 7 and up 3 TWELVE Suitable for ages 12 and up 4 SIXTEEN Suitable for ages 16 and up 5 EIGHTEEN Suitable for ages 18 and up
Value Name Description 1 ALCOHOL_REFERENCE References to alcohol 2 ANIMATED_BLOOD Animated blood 3 BLOOD Blood 4 BLOOD_AND_GORE Blood and gore 5 CARTOON_VIOLENCE Cartoon violence 6 COMIC_MISCHIEF Comic mischief 7 CRUDE_HUMOR Crude humor 8 DRUG_REFERENCE References to drugs 9 FANTASY_VIOLENCE Fantasy violence 10 INTENSE_VIOLENCE Intense violence 11 LANGUAGE Use of strong language 12 LYRICS Lyrics 13 MATURE_HUMOR Mature humor 14 NUDITY Nudity 15 PARTIAL_NUDITY Partial nudity 16 REAL_GAMBLING Real gambling 17 SEXUAL_CONTENT Sexual content 18 SEXUAL_THEMES Sexual themes 19 SEXUAL_VIOLENCE Sexual violence 20 SIMULATED_GAMBLING Simulated gambling 21 STRONG_LANGUAGE Strong language 22 STRONG_LYRICS Strong lyrics 23 STRONG_SEXUAL_CONTENT Strong sexual content 24 SUGGESTIVE_THEMES Suggestive themes 25 TOBACCO_REFERENCE References to tobacco 26 USE_OF_ALCOHOL Use of alcohol 27 USE_OF_DRUGS Use of drugs 28 USE_OF_TOBACCO Use of tobacco 29 VIOLENCE Violence 30 VIOLENT_REFERENCES Violent references 31 IN_GAME_PURCHASES In-game purchases 32 USERS_INTERACT User interaction 33 SHARES_LOCATION Location sharing 34 UNRESTRICTED_INTERNET Unrestricted internet access 35 MILD_BLOOD Mild blood 36 MILD_CARTOON_VIOLENCE Mild cartoon violence 37 MILD_FANTASY_VIOLENCE Mild fantasy violence 38 MILD_LANGUAGE Mild language 39 MILD_LYRICS Mild lyrics 40 MILD_SEXUAL_THEMES Mild sexual themes 41 MILD_SUGGESTIVE_THEMES Mild suggestive themes 42 MILD_VIOLENCE Mild violence 43 ANIMATED_VIOLENCE Animated violence
Value Name Description 1 VIOLENCE Depictions of violence 2 BAD_LANGUAGE Use of bad language 3 FEAR Scenes that may frighten 4 GAMBLING Depictions of gambling 5 SEX Depictions of sexual content 6 DRUGS Depictions of drugs 7 DISCRIMINATION Depictions of discrimination
Value Name Description 1 WINDOWS Windows OS 2 MACOS macOS 3 LINUX Linux
Field Type Description currency string The lower-cased ISO 4217 currency code currency_exponent integer The exponent to convert the amount to the displayed currency unit amount integer The price amount in the smallest currency unit sale_amount? integer The sale price amount in the smallest currency unit sale_percentage? integer The percentage discount of the sale price premium? map[integer, premium price object] The price for premium users per premium type
Field Type Description amount integer The price amount in the smallest currency unit percentage integer The percentage discount for premium users
Value Name Description 1 CONSTANT Regular pricing 2 APPLE_STICKER Apple sticker pack pricing
Field Type Description boost_price integer The number of boosts the powerup costs purchase_limit integer The maximum number of entitlements a guild can have for the powerup guild_features guild premium features objectThe features granted by the powerup category_type string The type of guild powerup static_image_url string URL of the static banner image for the powerup animated_image_url string URL of the animated banner image for the powerup store_removal_date? 1 ?ISO8601 datetime When the powerup will be removed from the store
1 Only included on store listing objects.
Field Type Description boost_price integer The number of boosts the powerup costs purchase_limit integer The maximum number of entitlements a guild can have for the powerup guild_features guild premium features objectThe features granted by the powerup category_type string The type of guild powerup available_providers array[string] The available providers (currently only ) memory integer The amount of RAM in megabytes that the game server provides cpu integer The amount of CPU cores that the game server provides storage integer The amount of storage in gigabytes that the game server provides max_slots integer Maximum amount of players that can connect to the game server memory_string string Human-readable amount of RAM that the game server provides player_string string Human-readable maximum amount of players that can connect to the game server
Value Description level Guild premium tier perk Additional guild perk game_server Game server attached to the guild
{
"boost_price" : 5 ,
"purchase_limit" : 1 ,
"guild_features" : {
"features" : [ "GAME_SERVERS" ] ,
"additional_emoji_slots" : 0 ,
"additional_sticker_slots" : 0 ,
"additional_sound_slots" : 0
} ,
"category_type" : "game_server" ,
"available_providers" : [ "SHOCKBYTE" ] ,
"memory" : 8192 ,
"cpu" : 2 ,
"storage" : 100 ,
"max_slots" : 40 ,
"memory_string" : "8GB" ,
"player_string" : "40+"
}
Field Type Description carousel_items array[store carousel item object] The carousel items for the listing label string The label for the listing expires_at ?ISO8601 datetime When the listing expires card_image_asset_id? snowflake The store asset ID for the card image card_background_image_asset_id? snowflake The store asset ID for the card background image price_tier? integer The base price of the SKU
{
"id" : "1333912750274904064" ,
"type" : 3 ,
"product_line" : 11 ,
"dependent_sku_id" : null ,
"application_id" : "521842831262875670" ,
"manifest_labels" : null ,
"access_type" : 1 ,
"name" : "3-Day Nitro Credit" ,
"features" : [ ] ,
"release_date" : null ,
"premium" : false ,
"slug" : "3-day-nitro-credit" ,
"flags" : 4 ,
"show_age_gate" : false ,
"price" : {
"amount" : 1400 ,
"currency" : "discord_orb" ,
"currency_exponent" : 0 ,
"premium" : {
"2" : {
"amount" : 1400 ,
"percentage" : 0
}
}
} ,
"tenant_metadata" : { } ,
"created_at" : "2025-08-05T20:53:39.133830+00:00" ,
"updated_at" : "2025-08-05T20:53:39.135755+00:00"
}
A listing for a marketable item on Discord. Tied to a single SKU.
Store listing objects can either be localized or unlocalized. Localized listings only serialize strings and pricing for the user's location, while unlocalized listings serialize all strings and pricing for all locales.
All objects serialized in the listing inherit this behavior.
Field Type Description id snowflake The ID of the listing sku SKU objectThe SKU associated with the listing child_skus? array[SKU object] The child SKUs associated with the category listing alternative_skus? array[SKU object] Alternative SKUs for the listing summary localized string A summary of the listing description? localized string A description of the listing tagline? ?localized string A tagline for the listing flavor_text? ?string Flavor text for the listing benefits? ?array[store listing benefit object] The benefits of the listing published? 1 boolean Whether the listing is published carousel_items? ?array[store carousel item object] The carousel items for the listing staff_notes? store note objectNotes from staff about the listing guild? ?partial guild object The public guild associated with the listing assets? array[store asset object] The store assets for the listing thumbnail? store asset objectThe thumbnail for the listing preview_video? store asset objectThe preview video for the listing header_background? store asset objectThe header background for the listing header_logo_dark_theme? store asset objectThe dark theme header logo for the listing header_logo_light_theme? store asset objectThe light theme header logo for the listing box_art? store asset objectThe box art for the listing hero_background? store asset objectThe hero background for the listing hero_video? store asset objectThe hero video for the listing entitlement_branch_id? ?snowflake The application branch ID granted by the listing published_at? ISO8601 datetime When the listing was published unpublished_at? ISO8601 datetime When the listing was unpublished powerup_metadata? 2 partial guild powerup metadata object The guild powerup metadata for the listing
1 Not included in contexts that are impossible for an unpublished listing to be in.
2 Only includes the , , , and fields.
Field Type Description id snowflake The ID of the benefit name string The name of the benefit description string The description of the benefit icon store listing icon objectThe icon for the benefit
Field Type Description type integer The type of icon store_asset_id 1 snowflake The store asset ID for the icon emoji 2 string The unicode emoji for the icon
1 Only included if is .
2 Only included if is .
Value Name Description 1 STORE_ASSET Icon is a store asset 2 EMOJI Icon is a unicode emoji
Field Type Description youtube_video_id? 1 ?string The YouTube video ID for the item asset_id? 1 snowflake The store asset ID for the item thumbnail_asset_id? snowflake The store asset ID for the thumbnail background_asset_id? ?snowflake The store asset ID for the background label? string The label for the item label_icon_asset_id? snowflake The store asset ID for the label icon
1 One of or must be provided.
Field Type Description user ?partial user object The user who made the note content string The note content
{
"id" : "983874530717990912" ,
"summary" : { "default" : "Support Discord and get sweet chat perks." } ,
"sku" : {
"id" : "978380684370378762" ,
"type" : 5 ,
"product_line" : 1 ,
"dependent_sku_id" : null ,
"application_id" : "521842831262875670" ,
"manifest_labels" : null ,
"access_type" : 1 ,
"name" : { "default" : "Nitro Basic" } ,
"features" : [ ] ,
"release_date" : null ,
"premium" : false ,
"slug" : "nitro-basic" ,
"flags" : 68 ,
"tenant_metadata" : { } ,
"created_at" : "2025-08-05T20:53:39.133830+00:00" ,
"updated_at" : "2025-08-05T20:53:39.135755+00:00"
} ,
"description" : { "default" : "Support Discord and get sweet chat perks." } ,
"published" : true ,
"thumbnail" : { "id" : "1039257000355307530" , "size" : 333286 , "mime_type" : "image/png" , "width" : 834 , "height" : 471 } ,
"benefits" : [ ]
}
A recurring payment to maintain entitlement to an SKU.
Field Type Description id snowflake The ID of the subscription plan name string The name of the subscription plan sku_id snowflake The ID of the SKU the plan belongs to interval integer The interval of the plan interval_count integer The number of intervals per billing cycle tax_inclusive boolean Whether the plan's prices are tax inclusive price 1 (deprecated) integer The price amount in the smallest currency unit currency 1 (deprecated) string The lower-cased ISO 4217 currency code of the plan's price prices 1 map[integer, subscription prices object] The prices for the plan per purchase type price 2 map[string, integer] The price for the plan per lower-cased ISO 4217 currency code
1 Only included when fetched from the Get Published Subscription Plans or Get Bulk Published Subscription Plans endpoints.
1 Only included when fetched from the Get Subscription Plans endpoint.
Field Type Description id snowflake The ID of the subscription plan name string The name of the subscription plan sku_id snowflake The ID of the SKU the plan belongs to interval integer The interval of the plan interval_count integer The number of intervals per billing cycle tax_inclusive boolean Whether the plan's prices are tax inclusive
Field Type Description country_prices country prices objectThe prices for the plan for the given country payment_source_prices map[snowflake, array[unit price object]] The prices for the plan per user payment source ID
Field Type Description country_code string The ISO 3166-1 alpha-2 country code prices array[unit price object] The prices for the plan in the given country
Value Name Description 1 MONTH Monthly subscription 2 YEAR Yearly subscription 3 DAY Daily subscription
Value Name Description 0 DEFAULT Default pricing 1 GIFT Gift purchase pricing 2 SALE Sale pricing 3 PREMIUM_TIER_1 Nitro Classic subscriber pricing 4 PREMIUM_TIER_2 Nitro subscriber pricing 5 MOBILE Mobile purchase pricing 6 PREMIUM_TIER_0 Nitro Basic subscriber pricing 7 MOBILE_PREMIUM_TIER_2 Mobile Nitro subscriber pricing
{
"id" : "944265636643602432" ,
"name" : "None 6 Month" ,
"interval" : 1 ,
"interval_count" : 6 ,
"tax_inclusive" : true ,
"sku_id" : "628379670982688768" ,
"currency" : "usd" ,
"price" : 0 ,
"price_tier" : null ,
"prices" : {
"0" : {
"country_prices" : {
"country_code" : "CA" ,
"prices" : [ { "currency" : "usd" , "amount" : 0 , "exponent" : 2 } ]
} ,
"payment_source_prices" : { }
}
}
}
An image or video associated with a store resource.
Field Type Description id snowflake The ID of the asset size integer The size of the asset in bytes mime_type string The asset's media type filename 1 string The filename of the asset width integer The width of the asset in pixels height integer The height of the asset in pixels
1 Only included when fetched from the Get Application Store Assets or Create Application Store Asset endpoints.
{
"id" : "1059634086995574874" ,
"size" : 4161529 ,
"mime_type" : "image/gif" ,
"filename" : "kitties.gif" ,
"width" : 464 ,
"height" : 512
}
An End User License Agreement represents a legal agreement between the application owner and the end user.
Field Type Description id snowflake The ID of the EULA name string The name of the EULA content string The content of the EULA
A collection of store listings in a unified showcase.
Field Type Description application_id snowflake The ID of the application application? partial application object The application title string The title of the storefront logo_asset_id? snowflake The ID of the logo store asset light_theme_logo_asset_id? snowflake The ID of the logo store asset for light theme pages array[storefront page object] The pages of the storefront store_listings array[store listing object] The store listings assets array[store asset object] The store assets
Field Type Description title? string The title of the page (max 256 characters) leaderboard? storefront leaderboard objectThe leaderboard on the page sku_ids array[snowflake] The IDs of the SKUs on the page (max 100) sections? array[storefront page section object] The sections on the page (max 5)
Field Type Description title? string The title of the leaderboard (max 256 characters) description? string The description of the leaderboard (max 512 characters) background_image_asset_id? snowflake The ID of the background image store asset
Field Type Description title? string The title of the page section (max 256 characters) sku_ids array[snowflake] The IDs of the SKUs on the page section (max 100)
GET/applications/{application.id}/skusTest
Returns a list of SKU objects for the given application. User must be the owner of the application or member of the owning team.
Field Type Description country_code? string The ISO 3166-1 alpha-2 country code localize? boolean Whether to localize the SKUs for the user's location (default true) with_bundled_skus? boolean Whether to include bundled SKUs within SKU objects in the response (default false)
Creates a new SKU. Returns the created SKU object on success. Requires an application with access to the store or monetization. User must be the owner of the application or member of the owning team.
Field Type Description type integer The type of SKU application_id snowflake The ID of the application the SKU belongs to name localized string The name of the SKU (1-256 characters) flags? integer The SKU flags (only can be set) legal_notice? localized string The legal notice for the SKU (max 1024 characters) dependent_sku_id? snowflake The ID of the prerequisite required to buy this SKU bundled_skus? array[snowflake] The IDs of the SKUs that are included when purchasing this SKU access_type? integer The access level of the SKU manifest_labels? array[snowflake] The IDs of the manifest labels associated with the SKU features? array[integer] The features of the SKU locales? array[string] The locales the SKU is available in genres? array[integer] The genres of the SKU content_ratings? map[integer, content rating object] The content ratings of the SKU per agency system_requirements? map[integer, system requirements object] The system requirements for each operating system the SKU supports price_tier? integer The base price of the SKU price? map[string, integer] Localized pricing overrides per lower-cased ISO 4217 currency code sale_price_tier? integer The sale price of the SKU sale_price? map[string, integer] Localized sale pricing overrides per lower-cased ISO 4217 currency code release_date? ISO8601 date When the SKU will be released
GET/store/skus/{sku.id}Test
Returns a SKU object for the given SKU ID. User must own the SKU's application or be a member of the owning team.
Field Type Description country_code? string The ISO 3166-1 alpha-2 country code localize? boolean Whether to localize the SKUs for the user's location (default true)
PATCH/store/skus/{sku.id}Test
Modifies an existing SKU. Returns the modified SKU object on success. User must own the SKU's application or be a developer of the owning team.
Field Type Description name? localized string The name of the SKU (1-256 characters) flags? integer The SKU flags (only can be set) legal_notice? localized string The legal notice for the SKU (max 1024 characters) dependent_sku_id? snowflake The ID of the prerequisite required to buy this SKU bundled_skus? array[snowflake] The IDs of the SKUs that are included when purchasing this SKU access_type? integer The access level of the SKU manifest_labels? array[snowflake] The IDs of the manifest labels associated with the SKU features? array[integer] The features of the SKU locales? array[string] The locales the SKU is available in genres? array[integer] The genres of the SKU content_ratings? map[integer, content rating object] The content ratings of the SKU per agency system_requirements? map[integer, system requirements object] The system requirements for each operating system the SKU supports price_tier? integer The base price of the SKU price? map[string, integer] Localized pricing overrides per lower-cased ISO 4217 currency code sale_price_tier? integer The sale price of the SKU sale_price? map[string, integer] Localized sale pricing overrides per lower-cased ISO 4217 currency code release_date? ISO8601 date When the SKU will be released
GET/store/skus/{sku.id}/listingsTest
Returns a list of store listing objects for the given SKU ID. User must own the SKU's application or be a member of the owning team.
Field Type Description country_code? string The ISO 3166-1 alpha-2 country code localize? boolean Whether to localize the SKUs for the user's location (default true)
Creates a new store listing. Returns the created store listing object on success. User must own the SKU's application or be a member of the owning team.
Field Type Description application_id snowflake The ID of the application the listing belongs to sku_id snowflake The ID of the SKU the listing is associated with child_sku_ids? array[snowflake] The IDs of the child SKUs associated with the category listing (max 100) summary localized string A summary of the listing (1-1024 characters) description localized string A description of the listing (1-8192 characters) tagline? localized string A tagline for the listing (max 1024 characters) published? boolean Whether the listing is published (default false) carousel_items? 1 ?array[store carousel item object] The carousel items for the listing guild_id? snowflake The ID of the public guild associated with the listing thumbnail_asset_id? snowflake The store asset ID for the thumbnail of the listing preview_video_asset_id? snowflake The store asset ID for the preview video of the listing header_background_asset_id? snowflake The store asset ID for the header background header_logo_dark_theme_asset_id? snowflake The store asset ID for the dark theme header logo of the listing header_logo_light_theme_asset_id? snowflake The store asset ID for the light theme header logo of the listing box_art_asset_id? snowflake hero_background_asset_id? snowflake The store asset ID for the hero background of the listing hero_video_asset_id? snowflake The store asset ID for the hero video of the listing
1 Only or can be set.
GET/store/listings/{listing.id}Test
Returns a store listing object for the given listing ID. User must own the listing's application or be a member of the owning team.
Field Type Description country_code? string The ISO 3166-1 alpha-2 country code localize? boolean Whether to localize the SKUs for the user's location (default true)
PATCH/store/listings/{listing.id}Test
Modifies an existing store listing. Returns the modified store listing object on success. User must own the listing's application or be a developer of the owning team.
Field Type Description child_sku_ids? array[snowflake] The IDs of the child SKUs associated with the category listing (max 100) summary? localized string A summary of the listing (1-1024 characters) description? localized string A description of the listing (1-8192 characters) tagline? localized string A tagline for the listing (max 1024 characters) published? boolean Whether the listing is published (default false) carousel_items? 1 ?array[store carousel item object] The carousel items for the listing guild_id? snowflake The ID of the public guild associated with the listing thumbnail_asset_id? snowflake The store asset ID for the thumbnail of the listing preview_video_asset_id? snowflake The store asset ID for the preview video of the listing header_background_asset_id? snowflake The store asset ID for the header background header_logo_dark_theme_asset_id? snowflake The store asset ID for the dark theme header logo of the listing header_logo_light_theme_asset_id? snowflake The store asset ID for the light theme header logo of the listing box_art_asset_id? snowflake hero_background_asset_id? snowflake The store asset ID for the hero background of the listing hero_video_asset_id? snowflake The store asset ID for the hero video of the listing
1 Only or can be set.
DELETE/store/listings/{listing.id}Test
Deletes an existing store listing. Returns a 204 empty response on success. User must own the listing's application or be a member of the owning team.
GET/store/published-listings/skusTest
Returns a list of published store listing objects for the given application ID.
Field Type Description application_id snowflake The application ID to get the listings for guild_id? snowflake The guild ID to fetch hidden listings for country_code? string The ISO 3166-1 alpha-2 country code localize? boolean Whether to localize the SKUs for the user's location (default true)
GET/store/published-listings/applications/{application.id}Test
Returns a store listing object for the primary SKU of the given application ID.
Field Type Description country_code? string The ISO 3166-1 alpha-2 country code localize? boolean Whether to localize the SKUs for the user's location (default true)
GET/store/published-listings/applicationsTest
Returns a list of store listing objects for the primary SKU of the given application IDs.
Field Type Description application_ids array[snowflake] The application IDs to get the listings for (1-100) country_code? string The ISO 3166-1 alpha-2 country code localize? boolean Whether to localize the SKUs for the user's location (default true)
GET/store/published-listings/skus/{sku.id}Test
Returns the store listing object for the given SKU ID.
Field Type Description country_code? string The ISO 3166-1 alpha-2 country code localize? boolean Whether to localize the SKUs for the user's location (default true)
GET/store/skus/{sku.id}/plansTest
Returns a list of subscription plan objects for the given SKU ID. User must own the SKU's application or be a member of the owning team.
GET/store/published-listings/skus/{sku.id}/subscription-plansTest
Returns a list of published subscription plan objects for the given SKU ID.
Field Type Description include_unpublished? 1 boolean Whether to include unpublished subscription plans (default false) revenue_surface? integer The revenue surface , used for analytics country_code? string The ISO 3166-1 alpha-2 country code payment_source_id? snowflake The ID of the payment source to get prices for
1 To access unpublished subscription plans, the user must own the SKU's application or be a member of the owning team.
Value Name Description 0 DISCOVERY Subscription discovery 1 CHECKOUT Subscription checkout
GET/store/published-listings/skus/subscription-plansTest
Returns a list of published subscription plan objects for the given SKU IDs.
Field Type Description sku_ids array[snowflake] The SKU IDs to get the subscription plans for (1-16) include_unpublished? 1 boolean Whether to include unpublished subscription plans (default false) revenue_surface? integer The revenue surface , used for analytics country_code? string The ISO 3166-1 alpha-2 country code payment_source_id? snowflake The ID of the payment source to get prices for
1 To access unpublished subscription plans, the user must own the SKUs' application or be a member of the owning team.
GET/store/skus/{sku.id}/purchaseTest
Returns an invoice object representing a purchase preview for the given SKU ID.
Field Type Description payment_source_id? snowflake The ID of the payment source to pay with currency? string The lower-cased ISO 4217 currency code to price in sku_subscription_plan_id? snowflake The ID of the subscription plan to purchase (required for subscription SKUs) gift? boolean Whether the purchase is a gift (default false) test_mode? boolean Whether the purchase is in test mode (default false) load_id? string A client-generated UUID used to identify the current checkout session
POST/store/skus/{sku.id}/purchaseTest
Creates a new purchase for the given SKU ID. Fires an Entitlement Create and Payment Update Gateway event.
Field Type Description payment_source_id? snowflake The ID of the payment source to pay with payment_source_token? ?string The token used to authorize with the payment source return_url? 1 ?string TThe URL to redirect to after payment is complete (max 2048 characters) country_code? string The ISO 3166-1 alpha-2 country code currency? string The lower-cased ISO 4217 currency code sku_subscription_plan_id? snowflake The ID of the subscription plan to purchase (required for subscription SKUs) gift? boolean Whether the purchase is a gift (default false) gift_info_options? gift info options objectAdditional metadata for gift purchases test_mode? boolean Whether the purchase is in test mode (default false) expected_amount? 2 integer The expected amount to be charged in the smallest currency unit expected_currency? 2 string The expected currency for the purchase in lower-cased ISO 4217 format purchase_token 2 string The purchase token of the payment client (max 1024 characters) gateway_checkout_context? ?gateway checkout context object The context for the gateway checkout, if applicable load_id string A client-generated UUID used to identify the current checkout session, used for purchase deduplication
1 If required, this URL is typically set to the Create Billing Popup Bridge Redirect endpoint with a of , which redirects the user back to the Discord client for handling.
2 If the actual currency or amount charged does not match these expected values, the purchase will fail.
3 See the section on payment clients for more information.
Field Type Description gift_style? ?integer The style of the gift code recipient_id? snowflake The ID of the user to directly send the gift to custom_message? ?string A custom message to include with the gift (max 190 characters) emoji_id? ?snowflake The ID of a guild's custom emoji emoji_name? ?string The unicode character of the emoji sound_id? ?snowflake The ID of the default soundboard sound to play with the gift reward_sku_ids? array[snowflake] The IDs of the promotional SKUs the gifter chooses to redeem as a reward for purchasing a gift (max 1)
Field Type Description entitlements array[entitlement object] The entitlements granted by the purchase library_applications? array[library application object] The library applications granted by the purchase applied_user_discounts? array[user discount offer object] The user discount offers applied to the purchase gift_code? string The gift code created by the purchase
GET/store/applications/{application.id}/assetsTest
Returns a list of store asset objects for the given application ID. User must be the owner of the application or member of the owning team.
POST/store/applications/{application.id}/assetsTest
Uploads a new store asset for the given application ID. Returns the created store asset object on success. User must be the owner of the application or developer of the owning team.
Field Type Description files file contents Contents of the store asset
DELETE/store/applications/{application.id}/assets/{asset.id}Test
Deletes the store asset with the given ID. Returns a 204 empty response on success. User must be the owner of the application or member of the owning team.
GET/store/price-tiersTest
Returns a list of integers representing the available store price tiers.
Value Name Description 1 GUILD_ROLE_SUBSCRIPTIONS Price tiers to use with guild role subscriptions 2 GUILD_PRODUCTS Price tiers to use with guild products
GET/store/price-tiers/{price_tier}Test
Returns a map of lower-cased ISO 4217 currency codes to integer prices representing localized pricing for the given price tier.
GET/store/eulas/{eula.id}Test
Returns a EULA object for the given ID.
GET/applications/{application.id}/store-layoutTest
Returns the store layout of the given application ID.
Field Type Description subscriptions array[store listing object] The listings the users can subscribe to otps array[store listing object] The listings the users can purchase subscription_plans array[subscription plan object] The subscription plans
POST/applications/{application.id}/storefront/publishTest
Modifies the SKU publishing states for the given application and SKU IDs.
Field Type Description publish_state integer The publish state for the SKUs sku_ids array[snowflake] The IDs of the SKUs to modify publish state for (1-255)
Value Name Description 1 UNPUBLISHED The SKUs are unpublished 2 PUBLISHED_HIDDEN The SKUs are published but hidden in the UI 3 PUBLISHED_STOREFRONT The SKUs are published and shown in the UI
Field Type Description store_layout_sku_ids? array[snowflake] The store layout SKU IDs store_listings? array[store listing object] The store listings
GET/store/consumable/pricing/{sku.id}Test
Returns the pricing information for a consumable SKU. These are currently as follows:
HD Streaming (1285377810587979827) Confetti (1316162456959057920) Field Type Description price SKU price objectThe pricing information for the SKU
GET/users/@me/consumable/hd-streamingTest
Returns the active HD streaming potion entitlement for the user.
Field Type Description entitlement ?entitlement object The active HD streaming entitlement
POST/users/@me/consumable/hd-streamingTest
Applies an HD streaming potion to a voice channel. Returns a 204 empty response on success. Fires a Channel Update Gateway event.
Field Type Description channel_id snowflake The ID of the voice channel to apply to
GET/users/@me/consumable/confettiTest
Returns the active confetti potion entitlement for the user.
Field Type Description entitlement ?entitlement object The active confetti potion entitlement num_potions integer Number of unused potions left
POST/users/@me/consumable/confettiTest
Applies a confetti potion to a message. To use custom emoji, you must encode it in the format with the emoji name and emoji ID. Returns a 204 empty response on success. Fires a Message Update Gateway event.
Field Type Description channel_id snowflake The ID of the channel the message is in message_id snowflake The ID of the message to apply the confetti potion to emoji_name string Unicode emoji or custom emoji name and ID
GET/users/@me/virtual-currency/balanceTest
Returns the current user's Orbs balance.
Field Type Description balance integer Amount of Orbs the user has
POST/virtual-currency/skus/{sku.id}/redeemTest
Purchases a SKU using virtual currency. Returns a list of entitlement objects granted to the current user.
Fires Payment Update , Virtual Currency Balance Update , Entitlement Create , and Entitlement Update Gateway events.
Field Type Description checkout_session_id string A client-generated UUID used to identify the current checkout session
GET/applications/storefront/interactions/premium-button/{store_listing.id}Test
Returns information about store listing, relevant SKUs, and subscription plans.
Field Type Description skus? array[SKU object] The relevant SKUs store_listings array[store listing object] The store listings subscription_plans? array[subscription plan object] The subscription plans
GET/partner-sdk/guilds/{guild.id}/application-storefrontTest
Returns a storefront object for the application linked to the given guild ID.
GET/partner-sdk/applications/{application.id}/skus/recommendationsTest
Returns recommended giftable SKUs for the specified users.
Field Type Description user_ids array[snowflake] The IDs of the users to return recommendations for (1-100) max_recommendations? integer Max number of recommendations to return (1-25, default ?) include_wishlists? boolean Whether to include SKUs on the users' wishlists
Value Description WISHLIST User has the SKU wishlisted RECOMMENDATION SKU is recommended for the user
GET/partner-sdk/application/{application.id}/skusTest
Returns a list of SKU objects related to in-game items for the given application. Requires a partner application with access to the social layer SDK and monetization. User must be the owner of the application or member of the owning team.
POST/partner-sdk/application/{application.id}/skusTest
Creates a new SKU for in-game item. Returns the created SKU object on success. Requires a partner application with access to the social layer SDK and monetization. User must be the owner of the application or member of the owning team.
Field Type Description name string The name of the SKU (max 256 characters) price_tier integer The base price of the SKU
GET/partner-sdk/applications/{application.id}/storefrontTest
Returns a storefront object for the given application ID.
PUT/partner-sdk/applications/{application.id}/storefrontTest
Modifies the application's storefront. Returns the modified storefront object on success. User must be the owner of the application or developer of the owning team.
Field Type Description title string The title of the storefront (max 256 characters) logo_asset_id? snowflake The ID of the logo store asset light_theme_logo_asset_id? snowflake The ID of the logo store asset for light theme pages array[storefront page object] The pages of the storefront (max 5)
DELETE/partner-sdk/applications/{application.id}/storefrontTest
Deletes the application's storefront. Returns a 204 empty response on success. User must be the owner of the application or developer of the owning team.
GET/partner-sdk/guilds/{guild.id}/application-storefront/skus/{sku.id}Test
Returns the storefront associated with the given SKU ID.
GET/partner-sdk/guilds/{guild.id}/application-storefront/announcementTest
Returns the most recent announcement on the storefront for the application linked to the given guild ID.
Field Type Description id snowflake The ID of the announcement application_id snowflake The ID of the application application_name string The name of the application asset_id snowflake The ID of the announcement store asset background_image_asset_id snowflake The ID of the background image store asset
{
"id" : "1461677124166483968" ,
"application_id" : "1346069614634864772" ,
"application_name" : "Marvel Rivals" ,
"asset_id" : "1461676869303664640" ,
"background_image_asset_id" : "1461676874102214730"
}
POST/partner-sdk/guilds/{guild.id}/application-storefront/skus/{sku.id}/eligibilityTest
Creates a interaction used to check whether the user is eligible to purchase a social layer SKU.
Field Type Description interaction_id snowflake The ID of the created interaction