Achievements7

Coupons7

Creators8

Daily Rewards6

Disputes1

Fraud Alerts1

GDPR Requests2

Item Categories7

Items9

Leaderboards8

LiveOps10

Locales5

Loyalty Program5

News7

Orders6

Pages8

Payments1

Payments' Dispute Evidence3

Players6

Players' Marketing Consents2

Players' Store Items1

Players' Subscriptions5

Price Points1

Price Templates5

Segmentation11

Store Promotions9

Stores15

Translation Glossaries5

Users6

Videos5

Webhooks7

Coupons

Update Coupon

Updates a coupon.

put/v1/coupons/{coupon_id}

Path parameters

coupon_idstring required

Request body

discount_percentinteger

The discount percent for the coupon

bonus_percentinteger

The bonus percent for the coupon

bonus_fixedinteger nullable

The fixed bonus amount for the coupon

discount_amount_usdinteger

The discount amount in USD for the coupon

expires_atinteger

The expiration date of the coupon

applicable_item_idsstring[]

The applicable item IDs

category_idstring

The coupon category ID

min_amountinteger

Require a minimum order amount to apply the coupon

max_redemptionsinteger

Limit the number of times this code can be redeemed

max_redemptions_per_userinteger

Limit the number of times a user can redeem the coupon

is_stackable_with_bonus_couponsboolean

Allow stacking with bonus coupons

stackable_bonus_limit_percentinteger

Limit the bonus percent when stacking with bonus coupons

is_stackable_with_discount_couponsboolean

Allow stacking with discount coupons

stackable_discount_limit_percentinteger

Limit the discount percent when stacking with discount coupons

store_item_discount_limit_percentinteger

Limit the combined store item and coupon discount percent

store_item_bonus_limit_percentinteger

Limit the combined store item and coupon bonus percent

start_atinteger

The timestamp when the coupon becomes valid

end_atinteger

The timestamp when the coupon ceases to be valid

player_idsstring[]

The player IDs that can redeem the coupon

exclude_player_idsstring[]

The player IDs that cannot redeem the coupon

namestring

The name of the coupon

Response

Successful Response

discount_percentinteger

The discount percent for the coupon

bonus_percentinteger

The bonus percent for the coupon

bonus_fixedinteger nullable

The fixed bonus amount for the coupon

discount_amount_usdinteger

The discount amount in USD for the coupon

expires_atinteger

The expiration date of the coupon

applicable_item_idsstring[]

The applicable item IDs

category_idstring

The coupon category ID

min_amountinteger

Require a minimum order amount to apply the coupon

max_redemptionsinteger

Limit the number of times this code can be redeemed

max_redemptions_per_userinteger

Limit the number of times a user can redeem the coupon

is_stackable_with_bonus_couponsboolean

Allow stacking with bonus coupons

stackable_bonus_limit_percentinteger

Limit the bonus percent when stacking with bonus coupons

is_stackable_with_discount_couponsboolean

Allow stacking with discount coupons

stackable_discount_limit_percentinteger

Limit the discount percent when stacking with discount coupons

store_item_discount_limit_percentinteger

Limit the combined store item and coupon discount percent

store_item_bonus_limit_percentinteger

Limit the combined store item and coupon bonus percent

start_atinteger

The timestamp when the coupon becomes valid

end_atinteger

The timestamp when the coupon ceases to be valid

player_idsstring[]

The player IDs that can redeem the coupon

exclude_player_idsstring[]

The player IDs that cannot redeem the coupon

namestring required

The name of the coupon

codestring required

The code of the coupon

type'bonus' | 'discount' | 'free_item' | 'vc' | 'non_benefit' | 'discount_fixed' | 'discount_reward_point' required

idstring required

The unique identifier of the coupon

current_balance_usdinteger

The current balance in USD for fixed discount coupon type

Changes

Changed in 4 of the 28 revisions of this API.287

Sep 23, 20261816e2044c07245See the full diff
- ▲
  the response property ///// became optional for the status
  response-property-became-optional
- ▲
  the response property /// became optional for the status
  response-property-became-optional
- ●
  added the new function enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new function enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new function enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new piggy_bank enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new function enum value to the request property ///
  request-property-enum-value-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 18, 2026fb9750c99d0a1See the full diff
- ●
  for the path request parameter coupon_id, the maxLength was set to 32
  request-parameter-max-length-set
Aug 25, 2026fbb6b66272c81See the full diff
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Aug 18, 2026ef61f771db1d31See the full diff
- ●
  the / request property's maxLength was set to 32
  request-property-max-length-set
- ●
  the request property's maxLength was set to 32
  request-property-max-length-set
- ●
  the /// request property's maxLength was set to 32
  request-property-max-length-set
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog