Release Notes
The release notes provide the latest updates to our API Reference documentation. It contains comprehensive information on all API modifications, including new features and version updates. Each release note details specific changes and any required actions for developers. By regularly reviewing this page, you can stay informed about the latest improvements to our platform and ensure you have the most current information to optimize your integration with Appcharge.
Pre-Authenticated Login Webhook
The Seamless Login Webhook has been renamed to the Pre-Authenticated Login Webhook.
Player Order Reporting Webhook
We added a new paymentPriceInDollar
property to Player Order Reporting Webhook. This property represents the base price of the offer in USD cents.
Note that this is not the same as originalPriceInDollar
, which is also the base price in USD cents—but if you’re using Appcharge’s Web Store and pricePointMetadata
is provided, then pricePointMetadata
overrides originalPriceInDollar
.
Create Checkout Session API
We added a new quantityDisplay
property to items
object in the Create Checkout Session API. This property overrides the quantity
value displayed in the checkout.
Auto-Update SDK
The new Auto-Update SDK enables you to seamlessly update your app without requiring players to manually download and install a new version. This allows you to quickly roll out critical updates, new content, or bug fixes. It ensures a smoother player experience and helps maintain version consistency.
Appcharge Payment Links
The new Appcharge Payment Links feature allows players to make secure purchases in your iOS game. Players can buy digital content such as bundles, coin packs, or skins through a secure and branded page outside your app, giving you more control over the purchase experience and a seamless checkout flow.
See a sample Unity app flow that guides you through the recommended process for integrating Appcharge Payment Links into an iOS game.
Personalization Trigger API
The new Personalization Trigger API enables you to invoke the Personalization API on demand, giving you more control over when player data is refreshed. This gives you the flexibility to respond to time sensitive moments, like when a player runs out of resources and needs a personalized refill offer. It also helps with operational fixes, such as correcting an invalid offer to avoid unnecessary costs.
Learn more about the Personalization feature.
Checkout Link Offers API
The Offers V2 API now includes a new Checkout Link Offers API, which allows you to generate deeplinks that direct players to the checkout page, pre-configured with a unique offer. This feature is useful for sending exclusive, personalized offers outside the webstore, such as through a social media broadcast distributor.
With the new Checkout Link Offers API you can:
Learn more in the Checkout Link Offers guide.
Personalization API
The Player Info Sync Webhook has been renamed to the Personalization API.
UTM Parameters
We added new utmSource
, utmMedium
, and utmCampaign
properties to the Player Authentication Webhook. These same properties are now also included as a utms
object within the storeMetadata
field of the Player Order Reporting Webhook. This allows you to track the origin of your players, the channels they came through, and the campaigns that brought them in.
Player Info Sync Webhook
The dynamicOfferUi
object is deprecated. See the new structure below:
For Rolling Offers:
dynamicOfferUi.badges
→offers.productsSequence.badges
dynamicOfferUi.offerDesignId
→offerDesignSyncOverride.offerDesignId
dynamicOfferUi.salePercentage
→offers.productsSequence.productSale.sale
dynamicOfferUi.salePercentageDisplayType
→offers.productsSequence.productSale.type
For all other offer types:
dynamicOfferUi.badges
→offers.badges
dynamicOfferUi.offerDesignId
→offerDesignOverride.offerDesignId
dynamicOfferUi.salePercentage
→offers.productSale.sale
dynamicOfferUi.salePercentageDisplayType
→offers.productSale.type
Note: These properties do not apply to Checkout Link Offers because there is no support for configuring badges, sale percentages, or offer designs for them.
Player Info Sync Webhook
We added a new playerLevelBanners
object to the Player Info Sync Webhook, allowing you to dynamically display specific banners to players based on their game level.
VueJS 3 SDK
We released a new VueJS 3 SDK that supports the latest Vue.js version, Vue 3. See the documentation for more details.
WebGL SDK for Unity
The new WebGL SDK for Unity provides a streamlined in-game payment solution, enabling secure and native transactions. With a quick and easy setup, it supports multiple payment methods, ensuring accessibility for all players. This integration enhances the player experience while maximizing revenue with minimal effort.
For updates to the SDK, refer to the WebGL SDK for Unity Changelog.
Offers V2 API
A new version of the Offers API is now available. Offers V2 API enables you to create and manage offers more effectively, helping to enhance player engagement and improve customer retention. It supports various offer types, including bundles, special offers, daily bonuses, and post-purchase deals.
With the Offers V2 API, you can:
- Create and update a bundle.
- Create and update a special offer.
- Create and update a rolling offer.
- Create and update a daily bonus.
- Create and update a post-purchase popup.
- Get and delete offers.
Key changes from Offers API → Offers V2 API
- A new
productSale
object includes theamountBeforeSale
property. - The
dynamicOfferUi
property is deprecated. Sending this in the payload will result in failure:dynamicOfferUi.badges
→ moved to root asbadges
dynamicOfferUi.salePercentage
→ moved toproductSale.salePercentage
dynamicOfferUi.salePercentageType
→ moved toproductSale.salePercentageType
- The
intervals
property is deprecated. Use theschedule
property instead. - The
coolDownInHours
property is deprecated. - The
publisherSectionId
property is now only relevant for the Bundles API.
Rolling Offers API
The Offers API contains a new Rolling Offers API that allows players to unlock deals in succession. As each offer is claimed, the next one is revealed, keeping players engaged and eager to continue. The rolling offer feature boosts player interaction and maximizes revenue potential.
With the new Rolling Offer API you can:
- Create a rolling offer.
- Update a rolling offer.
Learn more about the Rolling Offer feature.
Offers API
We added a new schedule
property in the Create an Offer and Update an Offer APIs, allowing you to specify the time intervals when promotions are available to players.