# Get virtual currency package list

Gets a virtual currency packages list for building a catalog.

Attention. All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields.

Endpoint: GET /v2/project/{project_id}/items/virtual_currency/package
Version: 1.0.0
Security: AuthForClient

## Path parameters:

  - `project_id` (integer, required)
    Project ID.
    Example: 44056

## Query parameters:

  - `limit` (integer)
    Limit for the number of elements on the page.
    Example: 50

  - `offset` (integer)
    Number of the element from which the list is generated (the count starts from 0).

  - `locale` (string)
    Response language. Two-letter lowercase language code per ISO 639-1.

  - `additional_fields[]` (array)
    The list of additional fields. These fields will be in the response if you send them in your request. Available fields media_list, order, long_description.

  - `country` (string)
    Country to calculate regional prices and restrictions for catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. If you do not specify the country explicitly, it will be calculated based on user's IP address.

## Response 200 fields (application/json):

  - `items` (array)
    Example: [{"sku":"vc_package_1","name":"VC Name first package","groups":[],"attributes":[],"type":"bundle","description":"VC Short Package Description","image_url":"http://vc_package_image.png","is_free":false,"price":{"amount":"2.0000","amount_without_discount":"2.0000","currency":"USD"},"bundle_type":"virtual_currency_package","content":[{"description":"Big Rocket - short description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","sku":"big_rocket","name":"Big Rocket","type":"virtual_currency","quantity":100,"inventory_options":{"consumable":{"usages_count":1}}}],"virtual_prices":[]},{"sku":"vc_package_3","name":"VC Name third package","groups":[],"attributes":[],"type":"bundle","description":"VC Short Package Description","image_url":"http://vc_package_image.png","is_free":false,"price":{"amount":"4.0000","amount_without_discount":"4.0000","currency":"USD"},"bundle_type":"virtual_currency_package","content":[{"description":"description","image_url":"http://image.png","sku":"shotgun_raider","name":"SHOTGUN FOR TRUE RAIDERS","type":"virtual_currency","quantity":200,"inventory_options":{"consumable":{"usages_count":1}}}],"virtual_prices":[]}]

  - `items.sku` (string)
    Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, periods, dashes, and underscores.
    Example: "big_rocket"

  - `items.name` (string)
    Item name.
    Example: "Big Rocket"

  - `items.groups` (array)
    Groups the item belongs to.
    Example: [{"external_id":"accessory","name":"Accessory"}]

  - `items.groups.external_id` (string)
    Example: "accessory"

  - `items.groups.name` (string)
    Example: "Accessory"

  - `items.attributes` (array)
    List of attributes and their values corresponding to the Game.

Attention. This part of response is available only if you send the additional_fields[]=attributes query parameter.

  - `items.attributes.external_id` (string)
    Unique attribute ID. The external_id may only contain lowercase Latin alphanumeric characters, dashes, and underscores.
    Example: "attribute_1"

  - `items.attributes.name` (string)
    Name of attribute.
    Example: "Genre"

  - `items.attributes.values` (array)

  - `items.attributes.values.external_id` (string)
    Unique value ID for an attribute. The external_id may only contain lowercase Latin alphanumeric characters, dashes, and underscores.
    Example: "attribute_value"

  - `items.attributes.values.value` (string)
    Value of attribute.
    Example: "Strategy"

  - `items.type` (string)
    Type of item: virtual_good/virtual_currency/bundle.
    Example: "bundle"

  - `items.bundle_type` (string)
    Type of bundle: standard/virtual_currency_package.
    Example: "virtual_currency_package"

  - `items.description` (string)
    Item description.
    Example: "Big Rocket - description"

  - `items.image_url` (string)
    Image URL.
    Example: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"

  - `items.is_free` (string)
    If true, the item is free.
    Example: "false"

  - `items.price` (object)
    Item prices.

  - `items.price.amount` (string)
    Discounted item price.
    Example: "100.99"

  - `items.price.amount_without_discount` (string)
    Item price.
    Example: "100.99"

  - `items.price.currency` (string)
    Default purchase currency. Three-letter code per [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
    Example: "USD"

  - `items.virtual_prices` (array)
    Virtual prices.

  - `items.virtual_prices.amount` (integer)
    Discounted item price in virtual currency.
    Example: 100

  - `items.virtual_prices.sku` (string)
    Virtual currency item SKU.
    Example: "vc_test"

  - `items.virtual_prices.is_default` (boolean)
    Whether price is default for item.
    Example: true

  - `items.virtual_prices.image_url` (string)
    Image of virtual currency.
    Example: "http://image.png"

  - `items.virtual_prices.name` (string)
    Virtual currency name.
    Example: "SHOTGUN FOR TRUE RAIDERS"

  - `items.virtual_prices.type` (string)
    Virtual currency type.
    Example: "virtual_currency"

  - `items.virtual_prices.description` (string)
    Virtual currency description.
    Example: "Big Rocket - description"

  - `items.content` (array)
    Virtual currency package content.
    Example: [{"description":"Big Rocket - short description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","sku":"big_rocket","name":"Big Rocket","type":"virtual_currency","quantity":100,"inventory_options":{"consumable":{"usages_count":1}}}]

  - `items.content.sku` (string)
    Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.
    Example: "big_rocket"

  - `items.content.quantity` (integer)
    Quantity of virtual currency in a package.
    Example: 250

  - `items.content.inventory_options` (object)
    Defines the inventory item options.

  - `items.content.inventory_options.consumable` (object,null)
    Defines the consumable properties if this is a consumable item, or null if this is a non-consumable item.

  - `items.content.inventory_options.consumable.usages_count` (integer,null)
    Total number of remaining uses if this is a consumable item, or null if this is a non-consumable item.
    Example: 1

  - `items.content.inventory_options.expiration_period` (object,null)
    Defines the expiration properties if this is a expired item, or null if this is a non-expired item.

  - `items.content.inventory_options.expiration_period.type` (string)
    Defines type of expiration of a item.
    Enum: "minute", "hour", "day", "week", "month", "year"

  - `items.content.inventory_options.expiration_period.value` (integer)
    Defines value for expiration period.
    Example: 1