curl -X GET \
'https://api.appcharge.com/coupons/coupon/summer26' \
-H 'x-publisher-token: <x-publisher-token>'
{
"name": "summer26",
"active": true,
"discountPercentage": 10,
"maxRedemptionsPerCustomer": 2,
"expiredBy": "2025-04-02T06:54:51.670Z",
"startsAt": "2025-02-02T06:54:51.670Z",
"supportedOfferExternalIds": ["bundle1", "rollingoffer3"],
"firstTimePurchase": false,
"allowedPlayers": ["player123", "player456", "player789"]
}
{
"error": "Invalid coupon name. Use only English letters and numbers."
}
{
"error": "Coupon not found."
}
{
"error": "Unexpected error. Please contact support."
}
Coupons
Get Coupon By Name
Retrieves a specific coupon by name.
GET
/
coupons
/
coupon
/
{couponName}
curl -X GET \
'https://api.appcharge.com/coupons/coupon/summer26' \
-H 'x-publisher-token: <x-publisher-token>'
{
"name": "summer26",
"active": true,
"discountPercentage": 10,
"maxRedemptionsPerCustomer": 2,
"expiredBy": "2025-04-02T06:54:51.670Z",
"startsAt": "2025-02-02T06:54:51.670Z",
"supportedOfferExternalIds": ["bundle1", "rollingoffer3"],
"firstTimePurchase": false,
"allowedPlayers": ["player123", "player456", "player789"]
}
{
"error": "Invalid coupon name. Use only English letters and numbers."
}
{
"error": "Coupon not found."
}
{
"error": "Unexpected error. Please contact support."
}
curl -X GET \
'https://api.appcharge.com/coupons/coupon/summer26' \
-H 'x-publisher-token: <x-publisher-token>'
{
"name": "summer26",
"active": true,
"discountPercentage": 10,
"maxRedemptionsPerCustomer": 2,
"expiredBy": "2025-04-02T06:54:51.670Z",
"startsAt": "2025-02-02T06:54:51.670Z",
"supportedOfferExternalIds": ["bundle1", "rollingoffer3"],
"firstTimePurchase": false,
"allowedPlayers": ["player123", "player456", "player789"]
}
{
"error": "Invalid coupon name. Use only English letters and numbers."
}
{
"error": "Coupon not found."
}
{
"error": "Unexpected error. Please contact support."
}
Authorizations
Publisher token, as displayed in the Publisher Dashboard.
Path Parameters
Coupon name.
Example:
"summer26"
Response
Coupon retrieved successfully.
Coupon name.
Example:
"summer26"
Whether the coupon is active.
Example:
true
Discount percentage applied by the coupon.
Example:
1
Maximum number of times a customer can redeem this coupon.
Example:
2
Expiration date of the coupon.
Example:
"2025-04-02T06:54:51.670Z"
Start date of the coupon validity.
Example:
"2025-02-02T06:54:51.670Z"
List of offer external IDs that support this coupon. Empty array means all offers are supported.
Example:
["bundle1", "rollingoffer3"]
Whether the coupon is only valid for first-time purchases.
Example:
false
List of player IDs allowed to use this coupon. Empty array means all players are allowed.
Example:
["player123", "player456", "player789"]
Was this page helpful?