Info Value
Updated on6 August 2019
Response formatJSON
HTTP MethodsGET
Response objectBundle
API Version1.0

Currency/Bundle/Get

Retrieve a single virtual currency bundle according to its ID or code.

Parameters

For this request either bundle_id or bundle_code is required. Both are not needed.

Parameter Type Description
bundle_idintegerThe ID of the bundle being requested
bundle_codestringThe code of the bundle being requested

Response

Element Type Description
bundle_idintegerThe ID of the bundle
game_idintegerThe game ID of the bundle
bundle_category_idintegerThe category ID of the bundle
currency_id_receivedintegerThe ID of the currency being received
bundle_codestringThe code of the bundle
bundle_category_codestringThe code of the category
currency_received_codestringThe code of the currency being received
bundle_namestringThe bundle name
bundle_descriptionstringThe bundle description
pricesarrayAn 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
promotionsarrayAn array of current promotions for the bundle
Indexed by price id with key in the format bundle_price_##
See Promotion Object
visiblebooleanWhether or not the bundle is visible
enabledbooleanWhether or not the bundle is enabled
display_orderintegerThe order in which the bundle should be displayed

Price Object

Element Type Description
bundle_price_idintegerThe ID of the price
currency_idintegerThe ID of the currency purchasing with
currency_codestringThe code of the currency purchasing with
priceinteger, floatThe price itself
display_symbol_afterbooleanWhether or not the currency symbol is displayed after the price
html_symbolstringThe HTML version of the currency symbol purchasing with
unicode_symbolstringThe unicode version of the currency symbol purchasing with
total_amountintegerThe total amount of the currency being received
free_amountintegerThe free amount of the currency being received
display_amountintegerThe display friendly version of the amount of currency being received
is_promotionbooleanWhether or not this price is a promotion
starts_atdatetimeThe date/time in UTC of when this price started
expires_atdatetimeThe date/time in UTC of when this price will finish

Promotion Object

Element Type Description
bundle_price_idintegerThe ID of the price
original_price_idintegerThe 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/Get&bundle_id=##

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

Sample response

{
	"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
}