Skip to content

Entitlement Skus

Version: Updated: 2023-11-29 16:56:05


Documentation for the Entitlement Skus Page

Entitlement Skus Schema

last_modified_account_idstringNoAccount ID of the user who last modified the resource
last_modified_timestampstringNoTimestamp of when the resource was last modified
created_timestampstringNoTimestamp of when the resource was created
custom_dataobjectNoCustom data associated with the resource
namestringNoName of the resource
descriptionstringNoDescription of the resource
platformobjectYesSee schema
loot_entitlementobjectNoSee schema
external_key_entitlementobjectNoSee schema
skustringYesThe External SKU.
sandbox_idstringNoID of the Sandbox
entitlement_sku_idstringYesThe Entitlement Sku ID.

Platform Enum Values

AnonAn enumeration.
BasicAn enumeration.
XboxLiveAn enumeration.
PSNAn enumeration.
NintendoNAIDAn enumeration.
NintendoSwitchAn enumeration.
NintendoPPIDAn enumeration.
GoogleAn enumeration.
GooglePlayAn enumeration.
AppleAn enumeration.
EpicAn enumeration.
SteamAn enumeration.
AmazonAn enumeration.
TwitchAn enumeration.

Loot_entitlement Schema

loot_idstringYesThe Loot ID.
typeobjectYesSee schema
loot_namestringNoThe Loot Name. Only included when Loot is expanded.
legacy_loot_idintegerNoThe Legacy Loot ID.

Type Enum Values

consumableConsumable entitlements are removed from the platform’s record keeping system when used.
durableDurable entitlements stay in the platform’s recorded keeping system and is granted to the Player each time entitlements are granted.
durable_single_useDurable single use entitlements stay in the platform’s recorded keeping system and is granted to the Player only once.

External_key_entitlement Schema

external_key_campaign_idstringYesThe External Key Campaign ID.
quantityintegerYesThe quantity of keys to grant to the player.
external_key_campaign_namestringNoThe External Key Campaign Name. Only included when External Key Campaign is expanded.