--- title: "Get Items" method: GET path: "/v1/items" tags: ["Items"] --- # Get Items `GET /v1/items` ## Query parameters - `limit` integer — A limit on the number of objects to be returned - `offset` integer — The number of objects to skip - `state` 'active' | 'archived' — An enumeration. - `search_string` string - `category_id` union - string - 'unset' — An enumeration. - `order_by` 'created_at' | 'modified_at' | 'name' | 'position' | 'price' — An enumeration. - `rarity_id` string - `item_stackable_type` 'stackable' | 'non_stackable' — An enumeration. - `sort_order` 'asc' | 'desc' — An enumeration. - `with_price` boolean - `item_price_type` 'fiat' | 'reward_points' | 'virtual_currency' — An enumeration. - `types` string — Optional comma separated list of types - `ids` string — Optional comma separated list of ids ## Response `200` Successful Response - union[] - union - ItemRead - `name` string, required — The name of the item - `description` string, nullable — The description of the item - `highlights` Highlights - `title` string - `description` string - `items` HighlightItem[], required - `image_url` string - `name` string - `description` string - `price` integer — The price of the item in minor [currency units](https://docs.aghanim.com/currencies/). The system will automatically adjust this to the closest available price point. If you want to set a specific price point, use `price_template_id` instead. - `price_point` integer — The price point for local prices `DEPRECATED` - `price_template_id` string — The ID of the price template - `reward_points_price` integer — The reward points price for local prices - `currency` 'USD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' | 'RP' | 'VC', required - `sku` string, required — The SKU of the item - `image_url` union — The URL of the image for the item - string, uri - '' - `image_url_apple` string, uri — The Apple-specific URL of the image for the item - `icon_url` union — The URL of the icon for the item - string, uri - '' - `icon_url_apple` string, uri — The Apple-specific URL of the icon for the item - `image_url_featured` union — The URL of the image for the item in the featured card - string, uri - '' - `image_url_featured_apple` string, uri — The Apple-specific URL of the image for the item in the featured card - `background_image_url` union — The URL of the background image for the item - string, uri - '' - `background_image_url_apple` string, uri — The Apple-specific URL of the background image for the item - `background_image_color` string — The color of the background image for the item - `featured_card_background_image_url` union — The URL of the featured card background image for the item - string, uri - '' - `featured_card_background_image_url_apple` string, uri — The Apple-specific URL of the featured card background image for the item - `type` 'item' | 'currency' | 'bundle' | 'lootbox' | 'subscription' | 'virtual_currency', required - `view_option` 'default' | 'skeleton' - `quantity` integer — The quantity of the item - `is_stackable` boolean, required — Whether the item is stackable - `is_currency` boolean, required — Whether the item is a currency. - `position` integer — Position of the item in list - `categories` string[] — The list of category IDs - `duration` integer — Item's in-game action in seconds - `enable_reward_points_redemption` boolean — Allows using Reward Points on purchase - `nested_items` NestedItem[] — The child items of the bundle - `id` string - `count` integer - `sku` string - `is_featured` boolean - `meta` object - `image_url` string, uri - `view_type` 'separated' - `id` string, required — The unique identifier of the item - `properties` ItemPropertyRelationRead[] — The item properties - `property_id` string, required - `data` ItemPropertyRelationData - `value` union - number - integer - string - `position` integer, required - `id` string, required - `item_id` string, required - `item_property` ItemPropertyRead, required - `name` string, required — The name of the property - `description` string — The description of the property - `icon_url` union — The URL of the icon for the property - string, uri - '' - `config` union, required — The config of the property - ItemPropertyConfigRange - … - ItemPropertyConfigNumber - … - ItemPropertyConfigString - … - `id` string, required — The unique identifier of the property - `source` 'order' | 'bonus' | 'bundle' | 'coupon' | 'lootbox' | 'free_item' | 'liveops' | 'daily_reward' | 'loyalty_reward' | 'progression_program' | 'rolling_offer' | 'pick_one_offer' - `rarity_id` string — The rarity id of the item - `item_rarity` ItemRarityRead - `name` string, required — Name of the item rarity - `color_background_badge` string — Background color of the badge with this rarity - `id` string, required - `discount_percent` integer — The discount percent for the item - `bonus_percent` integer — The bonus percent for the item - `is_custom` boolean - `created_at` number, required — The timestamp of when the item was created - `modified_at` number — The timestamp of when the item was modified - `archived_at` number — The timestamp of when the item was archived - `price_minor_unit` integer - `price_decimal` number - `fallback_item_id` string — The item that will be given as fallback if the main item can't be given to the player - `fallback_item_quantity` integer — The quantity of the fallback item - `meta` object - `model_type` 'ItemRead' - `nested_items_read` ItemRead[] - `fallback_item` ItemRead — recursive - `comment` string — Internal comment for this item - `is_system` boolean, nullable — If true, this item will be skipped when sending webhooks - LootboxRead - `name` string, required — The name of the item - `description` string, nullable — The description of the item - `highlights` Highlights - `title` string - `description` string - `items` HighlightItem[], required - `image_url` string - `name` string - `description` string - `price` integer — The price of the item in minor [currency units](https://docs.aghanim.com/currencies/). The system will automatically adjust this to the closest available price point. If you want to set a specific price point, use `price_template_id` instead. - `price_point` integer — The price point for local prices `DEPRECATED` - `price_template_id` string — The ID of the price template - `reward_points_price` integer — The reward points price for local prices - `currency` 'USD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' | 'RP' | 'VC', required - `sku` string, required — The SKU of the item - `image_url` union — The URL of the image for the item - string, uri - '' - `image_url_apple` string, uri — The Apple-specific URL of the image for the item - `icon_url` union — The URL of the icon for the item - string, uri - '' - `icon_url_apple` string, uri — The Apple-specific URL of the icon for the item - `image_url_featured` union — The URL of the image for the item in the featured card - string, uri - '' - `image_url_featured_apple` string, uri — The Apple-specific URL of the image for the item in the featured card - `background_image_url` union — The URL of the background image for the item - string, uri - '' - `background_image_url_apple` string, uri — The Apple-specific URL of the background image for the item - `background_image_color` string — The color of the background image for the item - `featured_card_background_image_url` union — The URL of the featured card background image for the item - string, uri - '' - `featured_card_background_image_url_apple` string, uri — The Apple-specific URL of the featured card background image for the item - `type` 'item' | 'currency' | 'bundle' | 'lootbox' | 'subscription' | 'virtual_currency', required - `view_option` 'default' | 'skeleton' - `quantity` integer — The quantity of the item - `is_stackable` boolean, required — Whether the item is stackable - `is_currency` boolean, required — Whether the item is a currency. - `position` integer — Position of the item in list - `categories` string[] — The list of category IDs - `duration` integer — Item's in-game action in seconds - `enable_reward_points_redemption` boolean — Allows using Reward Points on purchase - `lootbox_settings` LootboxSettings, required - `groups` union[], required - union - LootboxGroup - … - LootboxNestedItem - … - `claim_video_url` string - `claimed_video_url` string - `claim_video_url_mov` string - `claimed_video_url_mov` string - `view_type` 'default' | 'roulette' - `pity` PitySettings - `steps` PityStep[], required - `threshold` integer, required - `guaranteed_groups` union[], required - … - `repeat_last` boolean - `id` string, required — The unique identifier of the lootbox - `model_type` 'LootboxRead' - `groups` union[] — Groups with nested elements that can be dropped - union - LootboxGroupRead - `id` string, required - `name` string, required - `weight` integer, required - `nested_items` union, required - … - LootboxNestedItemRead - `name` string, required — The name of the item - `description` string — The description of the item - `highlights` Highlights - … - `price` integer — The price of the item in minor [currency units](https://docs.aghanim.com/currencies/). The system will automatically adjust this to the closest available price point. If you want to set a specific price point, use `price_template_id` instead. - `price_point` integer — The price point for local prices `DEPRECATED` - `price_template_id` string — The ID of the price template - `reward_points_price` integer — The reward points price for local prices - `currency` 'USD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' | 'RP' | 'VC', required - `sku` string, required — The SKU of the item - `image_url` union — The URL of the image for the item - … - `image_url_apple` string, uri — The Apple-specific URL of the image for the item - `icon_url` union — The URL of the icon for the item - … - `icon_url_apple` string, uri — The Apple-specific URL of the icon for the item - `image_url_featured` union — The URL of the image for the item in the featured card - … - `image_url_featured_apple` string, uri — The Apple-specific URL of the image for the item in the featured card - `background_image_url` union — The URL of the background image for the item - … - `background_image_url_apple` string, uri — The Apple-specific URL of the background image for the item - `background_image_color` string — The color of the background image for the item - `featured_card_background_image_url` union — The URL of the featured card background image for the item - … - `featured_card_background_image_url_apple` string, uri — The Apple-specific URL of the featured card background image for the item - `type` 'item' | 'currency' | 'bundle' | 'lootbox' | 'subscription' | 'virtual_currency', required - `view_option` 'default' | 'skeleton' - `quantity` integer — The quantity of the item - `is_stackable` boolean, required — Whether the item is stackable - `is_currency` boolean, required — Whether the item is a currency. - `position` integer — Position of the item in list - `categories` string[] — The list of category IDs - `duration` integer — Item's in-game action in seconds - `enable_reward_points_redemption` boolean — Allows using Reward Points on purchase - `nested_items` NestedItem[] — The child items of the bundle - … - `id` string, required — The unique identifier of the item - `properties` ItemPropertyRelationRead[] — The item properties - … - `source` 'order' | 'bonus' | 'bundle' | 'coupon' | 'lootbox' | 'free_item' | 'liveops' | 'daily_reward' | 'loyalty_reward' | 'progression_program' | 'rolling_offer' | 'pick_one_offer' - `rarity_id` string — The rarity id of the item - `item_rarity` ItemRarityRead - … - `discount_percent` integer — The discount percent for the item - `bonus_percent` integer — The bonus percent for the item - `is_custom` boolean - `created_at` number, required — The timestamp of when the item was created - `modified_at` number — The timestamp of when the item was modified - `archived_at` number — The timestamp of when the item was archived - `price_minor_unit` integer - `price_decimal` number - `fallback_item_id` string — The item that will be given as fallback if the main item can't be given to the player - `fallback_item_quantity` integer — The quantity of the fallback item - `meta` object - `model_type` 'PublicItemRead' - `nested_items_read` PublicItemRead[] - … - `fallback_item` PublicItemRead - … - `quantity_after_bonus` integer - `quantity_bonus_value` integer - `probability` number, required — The probability of the item appearing - `weight` integer, required - `reward_mode` 'repeating' | 'non_repeating' - `is_won` boolean — True when the user has already won this non-repeating item - `archived_at` number — The timestamp of when the lootbox was archived - `comment` string — Internal comment for this item - SubscriptionRead - `name` string, required — The name of the item - `description` string, nullable — The description of the item - `highlights` Highlights - `title` string - `description` string - `items` HighlightItem[], required - `image_url` string - `name` string - `description` string - `price` integer — The price of the item in minor [currency units](https://docs.aghanim.com/currencies/). The system will automatically adjust this to the closest available price point. If you want to set a specific price point, use `price_template_id` instead. - `price_point` integer — The price point for local prices `DEPRECATED` - `price_template_id` string — The ID of the price template - `reward_points_price` integer — The reward points price for local prices - `currency` 'USD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' | 'RP' | 'VC', required - `sku` string, required — The SKU of the item - `image_url` union — The URL of the image for the item - string, uri - '' - `image_url_apple` string, uri — The Apple-specific URL of the image for the item - `icon_url` union — The URL of the icon for the item - string, uri - '' - `icon_url_apple` string, uri — The Apple-specific URL of the icon for the item - `image_url_featured` union — The URL of the image for the item in the featured card - string, uri - '' - `image_url_featured_apple` string, uri — The Apple-specific URL of the image for the item in the featured card - `background_image_url` union — The URL of the background image for the item - string, uri - '' - `background_image_url_apple` string, uri — The Apple-specific URL of the background image for the item - `background_image_color` string — The color of the background image for the item - `featured_card_background_image_url` union — The URL of the featured card background image for the item - string, uri - '' - `featured_card_background_image_url_apple` string, uri — The Apple-specific URL of the featured card background image for the item - `type` 'item' | 'currency' | 'bundle' | 'lootbox' | 'subscription' | 'virtual_currency', required - `view_option` 'default' | 'skeleton' - `quantity` integer — The quantity of the item - `is_stackable` boolean, required — Whether the item is stackable - `is_currency` boolean, required — Whether the item is a currency. - `position` integer — Position of the item in list - `categories` string[] — The list of category IDs - `duration` integer — Item's in-game action in seconds - `enable_reward_points_redemption` boolean — Allows using Reward Points on purchase - `nested_items` NestedItem[] — The child items of the bundle - `id` string - `count` integer - `sku` string - `is_featured` boolean - `meta` object - `image_url` string, uri - `view_type` 'separated' - `meta` object - `id` string, required — The unique identifier of the subscription - `model_type` 'SubscriptionRead' - `created_at` number, required — The timestamp of when the subscription was created - `modified_at` number — The timestamp of when the subscription was modified - `archived_at` number — The timestamp of when the subscription was archived - `comment` string — Internal comment for this subscription - `subscription_settings` SubscriptionSettings, required - `plans` SubscriptionPlan[] — The subscription plans - `key` string, required — The unique key of the plan - `name` string, required — The display name of the plan - `billing_cycle` SubscriptionBillingCycle, required - `period_type` 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second', required - `period_value` integer, required — The number of periods in a billing cycle - `renewal_type` 'auto' | 'no_renew', required - `price` integer — The price in minor currency units - `price_point` integer — The price point for local prices - `price_template_id` string — The ID of the price template - `currency` 'USD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' | 'RP' | 'VC' - `grace_period` integer — The grace period in days before subscription is canceled - `grace_mode` 'free_to_paid' | 'paid_to_paid' - `trial_period` integer — The trial period in days - `account_lock_duration` integer — The duration in days to lock account after cancellation - `change_payment_mode` boolean — Whether changing payment method is allowed - `is_downgrade_supported` boolean — Whether downgrading to this plan is supported - `is_pause_allowed` boolean — Whether pausing the subscription is allowed - `is_reactivation_allowed` boolean — Whether reactivating the subscription is allowed - `offers` SubscriptionOffer[] — The list of special offers for this plan - `key` string, required — The unique key of the offer - `name` string — The display name of the offer - `description` string — The description of the offer - `discount_percent` integer — The discount percentage for the offer - `discount_duration` DiscountDuration - … - `eligibility_rules` SubscriptionOfferEligibility[] — The list of eligibility rules for the offer - `grace_extension` integer — The grace period extension in days - `trial_extension` integer — The trial period extension in days - `activation_limits` integer — The maximum number of times this offer can be activated - `benefits` string[] — The list of benefit descriptions for this plan - `nested_items` NestedItem[] — Nested items references for this subscription plan - `id` string - `count` integer - `sku` string - `is_featured` boolean - `meta` object - `image_url` string, uri - `view_type` 'separated' - `archived_at` number — The timestamp when the plan was archived - `type` 'default' | 'special' - VirtualCurrencyRead - `name` string, required — The name of the item - `description` string, nullable — The description of the item - `highlights` Highlights - `title` string - `description` string - `items` HighlightItem[], required - `image_url` string - `name` string - `description` string - `price` integer — The price of the item in minor [currency units](https://docs.aghanim.com/currencies/). The system will automatically adjust this to the closest available price point. If you want to set a specific price point, use `price_template_id` instead. - `price_point` integer — The price point for local prices `DEPRECATED` - `price_template_id` string — The ID of the price template - `reward_points_price` integer — The reward points price for local prices - `currency` 'USD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' | 'RP' | 'VC', required - `sku` string, required — The SKU of the item - `image_url` union — The URL of the image for the item - string, uri - '' - `image_url_apple` string, uri — The Apple-specific URL of the image for the item - `icon_url` union — The URL of the icon for the item - string, uri - '' - `icon_url_apple` string, uri — The Apple-specific URL of the icon for the item - `image_url_featured` union — The URL of the image for the item in the featured card - string, uri - '' - `image_url_featured_apple` string, uri — The Apple-specific URL of the image for the item in the featured card - `background_image_url` union — The URL of the background image for the item - string, uri - '' - `background_image_url_apple` string, uri — The Apple-specific URL of the background image for the item - `background_image_color` string — The color of the background image for the item - `featured_card_background_image_url` union — The URL of the featured card background image for the item - string, uri - '' - `featured_card_background_image_url_apple` string, uri — The Apple-specific URL of the featured card background image for the item - `type` 'item' | 'currency' | 'bundle' | 'lootbox' | 'subscription' | 'virtual_currency', required - `view_option` 'default' | 'skeleton' - `quantity` integer — The quantity of the item - `is_stackable` boolean, required — Whether the item is stackable - `is_currency` boolean, required — Whether the item is a currency. - `position` integer — Position of the item in list - `categories` string[] — The list of category IDs - `duration` integer — Item's in-game action in seconds - `enable_reward_points_redemption` boolean — Allows using Reward Points on purchase - `vc_settings` VirtualCurrencySettings, required - `rate` number - `enabled_for_checkout` boolean - `reward_active` boolean - `reward_percentage` number - `excluded_sales_channels` OrderSourceType[] - `price_source` 'local_price' | 'base_price' - `allow_non_secure_auth` boolean - `start_at` integer — The timestamp of when the virtual currency becomes active - `end_at` integer — The timestamp of when the virtual currency expires - `id` string, required — The unique identifier of the virtual currency - `model_type` 'VirtualCurrencyRead' - `archived_at` number — The timestamp of when the virtual currency was archived ## Other responses - `422` — Validation Error --- [API](https://skmtc.net/aghanim/apis/aghanim-server-to-server-api.md) · [All operations](https://skmtc.net/aghanim/apis/aghanim-server-to-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aghanim/aghanim-server-to-server-api/versions/0c1b4ac1865b/schema)