Redeem Coupon
NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Adds the virtual goods associated with the coupon to the user’s inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| CatalogNotConfigured | 1218 |
| CharacterNotFound | 1135 |
| CouponAlreadyRedeemed | 1226 |
| CouponCodeNotFound | 1016 |
| LegacyEconomyDisabled | 4016 |
| ProductDisabledForTitle | 1609 |
Authorizations
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Body
Coupon codes can be created for any item, or set of items, in the catalog for the title. This operation causes the coupon to be consumed, and the specific items to be awarded to the user. Attempting to re-use an already consumed code, or a code which has not yet been created in the service, will result in an error.
Coupon codes can be created for any item, or set of items, in the catalog for the title. This operation causes the coupon to be consumed, and the specific items to be awarded to the user. Attempting to re-use an already consumed code, or a code which has not yet been created in the service, will result in an error.
Generated coupon code to redeem.
Unique PlayFab assigned ID of the user on whom the operation will be performed.
Catalog version of the coupon.
Optional identifier for the Character that should receive the item. If null, item is added to the player
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
