How to Create Coupon Codes for Your STQRY App

There are 2 kinds of codes: app-wide coupon codes and coupon codes for tours. While the app-wide coupon codes allow you to lock the whole app, the coupon codes for tours allow you to lock individual tours or collections in your app.

In this help article, you will learn about

• What are Coupon Codes?
• Creating Coupon Codes for Tours
• Creating App-Wide Coupon Codes
• API Support for Dynamic Coupon Code Generation
• Uploading Coupon Codes
• Important Notes

What are Coupon Codes?

Coupon codes are electronic codes that can be automatically generated or customized for two main purposes:

1. Monetization – Used to unlock premium content, special features, or discounts within an app, helping to drive revenue.
2. Content Security – Restrict access to certain content, ensuring only authorized users can view it, often used in private or exclusive apps.

Creating Coupon Codes for Tours

Here are the steps to set up coupon codes for tours:

1. Access the coupon code setting screen by choosing Project >> your app (project) >> Submit tab >> Coupons & Pricing >> Lock the Content.
2. To create a lock screen, choose Manage Locks.
3. On the open window, choose Tours (or List) that you want to lock the content then choose Manage Lock Content.
4.  On the open window, toggle the inactive button. You can fill out the optional information on the left-hand side then hit Save & Close.
5. To create a coupon code for a tour, click the Generate Codes button next to the Manage Locks button. From the dropdown menu, select the tour or list where the codes will apply.
6. Customize your coupon codes using the following options:

   • One: Manually create a single custom code.

   • Multiple: Automatically generate a list of random codes.

   • Validation Range: Define the specific time range during which the coupon is active.

   • Time Zone: Set the time zone to determine the start and end dates for the code's validity.

   • Code Duration: Specify the duration (in hours or days) for the code to remain active after redemption.

   • Maximum Number of Redemptions: Define the times the code can be redeemed before becoming invalid. Enter "1" to create a single-use code.

Please ensure that you check for updated content in the app settings to access the latest version of the app. The app also updates automatically every 24 hours. If you remove a coupon code for a tour, be sure to check for updated content or reinstall the app to see the changes.

You can set up both in-app purchases and coupon codes for tours at the same time. 

Creating App-Wide Coupon Codes

1. Access the coupon code setting screen by choosing Project >> your app (project) >> Submit tab >> Coupons & Pricing >> Lock the App.
2. To create a lock screen, choose Manage Locks  
3. On the open window, toggle the Lock the app button. You can fill out the optional information on the left-hand side then hit Save & Close 

4.  To create an app wide coupon code, choose the Generate Codes button (next to the Manage Locksbutton. Customize your coupon codes using the following options:
   • One: Manually create a single custom code. 
   • Multiple: Automatically generate a list of random codes.
   • Time Zone: Set the time zone to determine the start and end dates for the code's validity.
   • Code Duration: Specify the duration (in hours or days) the code remains active after redemption.
   • Maximum Number of Redemptions: Define the total times the code can be redeemed before becoming invalid. Enter "1" to create a single-use code.

Make sure you check for updated content in the app settings to get the updated version of your app. The app is also updated automatically every 24 hours. If you remove an app-wide code, the change will need a couple of hours to be applicable.

API Support for Dynamic Coupon Code Generation

We also offer free API support for dynamically generating customized coupon codes in real-time. 

You can find our API reference at: https://developer.stqry.com/api.html. To generate and manage coupon codes, refer specifically to these routes:

• POST /api/public/codes
• PUT /api/public/codes/{id}

Uploading Coupon Codes

STQRY allows you to upload a batch of coupon codes to unlock specific tours, collections, or full app access. To get started, download the coupon code template and complete it according to your access needs. Once filled out, share the file with your Customer Success Manager or email it to support@stqry.com for processing.

Required Fields:

• coupon_code (required): The code users will enter in the app. Each code must be unique for a given linked_id and linked_type.
• linked_id (required): The ID of the Collection (e.g., Tour or List) or Project (if the code unlocks the entire app).
  If you’re unsure about which ID to use, please check with your Customer Success Manager.
• linked_type (required): Skip this field for now. Bundles are not yet supported. This field will be updated once the feature becomes available.

Optional Fields:

• valid_from: The start date when the coupon becomes active.
• valid_to: The end date after which the coupon becomes invalid.
• timezone: Specifies the timezone for the valid_from and valid_to dates (if used).
• max_redemptions: Limits the number of times a coupon can be redeemed. Leave blank for unlimited use.
• expire_after: Sets a time limit (in minutes) after the first use, after which the coupon will expire. Leave blank for no expiry after redemption.
• tags: A semicolon-separated list of tags you can add to help organize and locate items more easily in the builder. Note that the system will also add an automatic import tag

Important Notes

• Click on the Download CSV button will allow you to download a list of active codes.
• The code usage is tracked in the redemptions column. 
• After the validation date or if you cancel a code, the end-user will no longer have access to the tour content
• App-wide coupons will not allow you to bypass App Store or Google Play payments. Entering the coupon code will come after the app is downloaded.

For more details, please reach out to your assigned Customer Success Manager or contact us at support@stqry.com.