Get virtual currency by SKU

Note

This endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.

SecurityXsollaLoginUserJWT

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
virtual_currency_sku required	string Virtual currency SKU. Example: crystal

query Parameters

locale	string Default: "en" Response language. Two-letter lowercase language code per ISO 639-1.
country	string Two-letter uppercase country code per ISO 3166-1 alpha-2. Shows regional prices and restrictions for a catalog if those were specified while creating an item. Note If you do not specify the country explicitly, it will be set based on user's IP address. Example: country=US
show_inactive_time_limited_items	integer Default: 0 Shows time-limited items that are not available to the user. The validity period of such items has not started or has already expired. Example: show_inactive_time_limited_items=1

Responses

200

The virtual currency was successfully received.

Request samples

Response samples

application/json

{"item_id": 451414,
"sku": "crystal",
"type": "virtual_currency",
"name": {"en": "Crystals"
},
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"price": {"amount": 100,
"amount_without_discount": 100,
"currency": "USD"
},
"virtual_prices": [ ],
"can_be_bought": true,
"promotions": [ ],
"limits": null,
"periods": [{"date_from": "2023-08-11T10:00:00+03:00",
"date_until": "2023-08-11T20:00:00+03:00"
}
],
"attributes": [{"external_id": "attr1",
"name": {"en-US": "Attribute"
},
"values": [{"external_id": "val1",
"value": {"en-US": "Value"
}
},
{"external_id": "val2",
"value": {"en-US": "Value"
}
}
]
}
],
"is_free": false,
"groups": [ ],
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": null
},
"custom_attributes": {"purchased": 0,
"attr": "value"
}
}