Version: 1.0.0.0 Updated: 2023-11-29 16:56:05
Summary
Documentation for the Entitlement Skus Page
Entitlement Skus Schema
| Name | Type | Required | Description |
|---|
| last_modified_account_id | string | No | Account ID of the user who last modified the resource |
| last_modified_timestamp | string | No | Timestamp of when the resource was last modified |
| created_timestamp | string | No | Timestamp of when the resource was created |
| custom_data | object | No | Custom data associated with the resource |
| name | string | No | Name of the resource |
| description | string | No | Description of the resource |
| platform | object | Yes | See schema |
| loot_entitlement | object | No | See schema |
| external_key_entitlement | object | No | See schema |
| sku | string | Yes | The External SKU. |
| sandbox_id | string | No | ID of the Sandbox |
| entitlement_sku_id | string | Yes | The Entitlement Sku ID. |
| | | |
| Value | Description |
|---|
| Anon | An enumeration. |
| Basic | An enumeration. |
| XboxLive | An enumeration. |
| PSN | An enumeration. |
| NintendoNAID | An enumeration. |
| NintendoSwitch | An enumeration. |
| NintendoPPID | An enumeration. |
| Google | An enumeration. |
| GooglePlay | An enumeration. |
| Apple | An enumeration. |
| Epic | An enumeration. |
| Steam | An enumeration. |
| Amazon | An enumeration. |
| Twitch | An enumeration. |
Loot_entitlement Schema
| Name | Type | Required | Description |
|---|
| loot_id | string | Yes | The Loot ID. |
| type | object | Yes | See schema |
| loot_name | string | No | The Loot Name. Only included when Loot is expanded. |
| legacy_loot_id | integer | No | The Legacy Loot ID. |
| | | |
Type Enum Values
| Value | Description |
|---|
| consumable | Consumable entitlements are removed from the platform’s record keeping system when used. |
| durable | Durable entitlements stay in the platform’s recorded keeping system and is granted to the Player each time entitlements are granted. |
| durable_single_use | Durable single use entitlements stay in the platform’s recorded keeping system and is granted to the Player only once. |
External_key_entitlement Schema
| Name | Type | Required | Description |
|---|
| external_key_campaign_id | string | Yes | The External Key Campaign ID. |
| quantity | integer | Yes | The quantity of keys to grant to the player. |
| external_key_campaign_name | string | No | The External Key Campaign Name. Only included when External Key Campaign is expanded. |
