Get list of virtual currency packages for administration

get/v2/project/{project_id}/admin/items/virtual_currency/package

Gets the list of virtual currency packages within a project for administration.

Note

Do not use this endpoint for building a store catalog.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056

query Parameters

limit	integer Limit for the number of elements on the page. Example: limit=50
offset	integer Number of the element from which the list is generated (the count starts from 0). Example: offset=0
promo_code	string [ 1 .. 128 ] characters Unique case sensitive code. Contains letters and numbers. Example: promo_code=WINTER2021

Responses

200

The list of virtual currency packages was successfully received.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

Request samples

Response samples

application/json

{"items": [{"sku": "crystal_pack_1",
"name": {"en": "Small crystal pack"
},
"type": "bundle",
"description": {"en": "Crystals x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png",
"long_description": null,
"attributes": [{"external_id": "attr_1",
"name": {"en-US": "OK"
},
"values": [{"external_id": "val1",
"value": {"en-US": "VALUE"
}
},
{"external_id": "val2",
"value": {"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [ ],
"prices": [{"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [ ],
"vc_prices": [ ],
"is_enabled": true,
"is_show_in_store": true,
"regions": [ ],
"bundle_type": "virtual_currency_package",
"content": [{"description": {"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "crystal",
"name": {"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"inventory_options": {"consumable": true,
"expiration_period": null
},
"quantity": 100
}
],
"limits": {"per_user": {"total": 5
},
"per_item": null,
"recurrent_schedule": {"per_user": {"interval_type": "daily",
"day_of_week": null,
"day_of_month": null,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {"purchased": 0,
"attr": "value"
}
},
{"sku": "crystal_pack_2",
"name": {"en": "Medium crystal pack"
},
"type": "bundle",
"description": {"en": "Crystals x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/431a40dd8c99290dd761508964ddbacf.png",
"long_description": null,
"attributes": [ ],
"is_free": false,
"order": 1,
"groups": [ ],
"prices": [{"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [ ],
"vc_prices": [ ],
"is_enabled": true,
"is_show_in_store": true,
"regions": [ ],
"bundle_type": "virtual_currency_package",
"content": [{"description": {"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "crystal",
"name": {"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"inventory_options": {"consumable": true,
"expiration_period": null
},
"quantity": 500
}
],
"limits": {"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [{"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{"sku": "crystal_pack_3",
"name": {"en": "Massive crystal pack"
},
"type": "bundle",
"description": {"en": "Crystals x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/1d67a1d2f92d69e021a97effa692dff3.png",
"long_description": null,
"attributes": [ ],
"is_free": false,
"order": 1,
"groups": [ ],
"prices": [{"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [ ],
"vc_prices": [ ],
"is_enabled": true,
"is_show_in_store": true,
"regions": [ ],
"bundle_type": "virtual_currency_package",
"content": [{"description": {"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "crystal",
"name": {"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"inventory_options": {"consumable": true,
"expiration_period": null
},
"quantity": 1500
}
],
"limits": {"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [ ]
},
{"sku": "gold_pack_1",
"name": {"en": "Small gold pack"
},
"type": "bundle",
"description": {"en": "Gold x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/09984ff0a3ae6b367c9c886b31366950.png",
"long_description": null,
"attributes": [ ],
"is_free": false,
"order": 1,
"groups": [ ],
"prices": [{"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [ ],
"vc_prices": [ ],
"is_enabled": true,
"is_show_in_store": true,
"regions": [ ],
"bundle_type": "virtual_currency_package",
"content": [{"description": {"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "gold",
"name": {"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"inventory_options": {"consumable": true,
"expiration_period": null
},
"quantity": 100
}
],
"limits": {"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [ ]
},
{"sku": "gold_pack_2",
"name": {"en": "Medium gold pack"
},
"type": "bundle",
"description": {"en": "Gold x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/b5d8130bdaf28aa55c43a68aa3ca0ef4.png",
"long_description": null,
"attributes": [{"external_id": "attr_1",
"name": {"en-US": "OK"
},
"values": [{"external_id": "val1",
"value": {"en-US": "VALUE"
}
},
{"external_id": "val2",
"value": {"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [ ],
"prices": [{"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [ ],
"vc_prices": [ ],
"is_enabled": true,
"is_show_in_store": true,
"regions": [ ],
"bundle_type": "virtual_currency_package",
"content": [{"description": {"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "gold",
"name": {"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"inventory_options": {"consumable": true,
"expiration_period": null
},
"quantity": 500
}
],
"limits": {"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [ ]
},
{"sku": "gold_pack_3",
"name": {"en": "Large gold pack"
},
"type": "bundle",
"description": {"en": "Gold x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/dea74a3667807d5502a4acb8f4c879ca.png",
"long_description": null,
"attributes": [{"external_id": "attr_1",
"name": {"en-US": "OK"
},
"values": [{"external_id": "val1",
"value": {"en-US": "VALUE"
}
},
{"external_id": "val2",
"value": {"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [ ],
"prices": [{"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [ ],
"vc_prices": [ ],
"is_enabled": true,
"is_show_in_store": true,
"regions": [ ],
"bundle_type": "virtual_currency_package",
"content": [{"description": {"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "gold",
"name": {"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"inventory_options": {"consumable": true,
"expiration_period": null
},
"quantity": 1500
}
],
"limits": {"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [ ]
}
]
}