Sign in

v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB
Coupons

Updates an existing coupon. Only the fields provided in the request body will be updated.

patch/coupons/coupon/{couponName}

Request body

activeboolean

Whether the coupon is active.

maxRedemptionsPerCustomerinteger nullable

Maximum number of times a customer can redeem this coupon. Set to null to remove the maximum redemptions per customer.

expiredBystring date-time nullable

Expiration date of the coupon. Set to null to remove the expiration date and make the coupon permanent.

startsAtstring date-time

Start date of the coupon validity. If not provided, defaults to current date and time.

supportedOfferExternalIdsstring[]

List of offer external IDs that support this coupon. Empty array means all offers are supported.

Note: This represents both the offer.sku value in the Create Checkout Session API, and the publisherOfferId in the Offers V2 API.

firstTimePurchaseboolean

Whether the coupon is only valid for first-time purchases.

allowedPlayersstring[]

List of player IDs allowed to use this coupon. Empty array means all players are allowed.

Example request

{
  "maxRedemptionsPerCustomer": 5,
  "expiredBy": "2026-12-31T23:59:59.000Z",
  "startsAt": "2026-06-16T09:30:53.378Z",
  "supportedOfferExternalIds": [
    "bundle1",
    "rollingoffer3"
  ],
  "allowedPlayers": [
    "player123",
    "player456"
  ]
}

Response

Coupon updated successfully.

namestring

Coupon name.

activeboolean

Whether the coupon is active.

discountPercentagenumber

Discount percentage applied by the coupon.

maxRedemptionsPerCustomerinteger

Maximum number of times a customer can redeem this coupon.

expiredBystring date-time

Expiration date of the coupon.

startsAtstring date-time

Start date of the coupon validity.

supportedOfferExternalIdsstring[]

List of offer external IDs that support this coupon. Empty array means all offers are supported.

firstTimePurchaseboolean

Whether the coupon is only valid for first-time purchases.

allowedPlayersstring[]

List of player IDs allowed to use this coupon. Empty array means all players are allowed.

Example response

{
  "name": "summer26",
  "active": true,
  "discountPercentage": 1,
  "maxRedemptionsPerCustomer": 2,
  "expiredBy": "2025-04-02T06:54:51.670Z",
  "startsAt": "2025-02-02T06:54:51.670Z",
  "supportedOfferExternalIds": [
    "bundle1",
    "rollingoffer3"
  ],
  "allowedPlayers": [
    "player123",
    "player456",
    "player789"
  ]
}