Info Value
Updated on 11 July 2019
Response format JSON
HTTP Methods GET
Response object Bundle
API Version 1.0

Currency/Bundle/List

Retrieve all virtual currency bundles for a game, or all bundles for a game in a certain category.

Parameters

Parameter Type Description
currency_id_received integer The ID of the currency being given
bundle_category_id
(optional)
integer The ID of the category of bundles being requested
bundle_category_code
(optional)
string The code of the category of bundles being requested

Response

Returns an array of bundles, indexed by bundle id in the format bundle_##.

Element Type Description
bundle_id integer The ID of the bundle
game_id integer The game ID of the bundle
bundle_category_id integer The category ID of the bundle
currency_id_received integer The ID of the currency being received
bundle_code string The code of the bundle
bundle_category_code string The code of the category
currency_received_code string The code of the currency being received
bundle_name string The bundle name
bundle_description string The bundle description
prices array An array of available prices for the bundle, with the most relevant returned first
Indexed by price id with key in the format bundle_price_##
See Price Object
promotions array An array of current promotions for the bundle
Indexed by price id with key in the format bundle_price_##
See Promotion Object
visible boolean Whether or not the bundle is visible
enabled boolean Whether or not the bundle is enabled
display_order integer The order in which the bundle should be displayed

Price Object

Element Type Description
bundle_price_id integer The ID of the price
currency_id integer The ID of the currency purchasing with
currency_code string The code of the currency purchasing with
price integer, float The price itself
display_symbol_after boolean Whether or not the currency symbol is displayed after the price
html_symbol string The HTML version of the currency symbol purchasing with
unicode_symbol string The unicode version of the currency symbol purchasing with
total_amount integer The total amount of the currency being received
free_amount integer The free amount of the currency being received
display_amount integer The display friendly version of the amount of currency being received
is_promotion boolean Whether or not this price is a promotion
starts_at datetime The date/time in UTC of when this price started
expires_at datetime The date/time in UTC of when this price will finish

Promotion Object

Element Type Description
bundle_price_id integer The ID of the price
original_price_id integer The ID of the original price, the price that will the game will fall back to once the promotion has ended

Example

Request

https://api.miniclip.com/json/?app_id=##&secret=##&signature=##&method=Currency/Bundle/List

https://api.miniclip.com/json/?app_id=##&secret=##&signature=##&method=Currency/Bundle/List&bundle_category_id=##

https://api.miniclip.com/json/?app_id=##&secret=##&signature=##&method=Currency/Bundle/List&bundle_category_code=##

Sample response

{
	"bundle_id_123" : {
		"bundle_id" : 123,
		"game_id" : 1234,
		"bundle_category_id" : 1,
		"currency_id_received" : 987,
		"bundle_code" : "TEST_BUNDLE",
		"bundle_category_code" : "TEST_CATEGORY",
		"currency_received_code" : "TEST_CURRENCY",
		"bundle_name" : "Test Bundle",
		"bundle_description" : "A test bundle",
		"prices" : {
			"bundle_price_123" : {
				"bundle_price_id" : 123,
				"currency_id" : 123,
				"currency_code" : "TC",
				"price" : 9.99,
				"display_symbol_after" : false,
				"html_symbol" : "$",
				"unicode_symbol" : "$",
				"total_amount" : 10,
				"free_amount" : 5,
				"amount" : 5,
				"is_promotion" : true,
				"starts_at" : "2013-12-01 00:00:00",
				"expires_at" : null
			}
		},
		"promotions" : {
			"bundle_price_123" : {
				"bundle_price_id" : 123,
				"original_price_id" : 987
			}
		},
		"visible" : true,
		"enabled" : true
	},
	...
}