- Create a coupon with customizable discount percentages and restrictions.
- Retrieve a coupon by name to view its details and settings.
- Update an existing coupon.
- Bulk create promo codes for a coupon to distribute to players.
- Retrieve a promo code.
- Retrieve a list of all promo codes.
- Activate or deactivate promo codes for a specific coupon.
Before you begin
Review the following before you begin:- A coupon must be created before you can create promo codes for it.
- When using the Create Coupon API, you can restrict the coupon by setting:
supportedOfferExternalIds: Limits the coupon to specific offers. Value must be the existing offer’s External ID.allowedPlayers: Limits the coupon to specific players.firstTimePurchase: Limits the coupon to first-time buyers in the web store.
Terminology
- Coupon: A discount configuration that defines the discount percentage and rules such as expiration dates, allowed players, and supported offers.
- Promo code: A unique code associated with a coupon that players enter at checkout to receive the discount. Each promo code can have its own redemption limit.