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.
The new Translations API service lets you manage translations in the web store, checkout, and game portal, allowing players to view content in their preferred language. The Translations API service includes the following endpoints:
Get Translations: Retrieves a list of all translatable fields and their translations.
Set Translations: Sets translation content for translatable fields.
We’ve updated our terminology to make it more consistent and easier to use:Grant Award Callback is now called Grant Award Callback. For more details, see the Awards API service.Learn more about the Awards feature.
OTP Authentication Webhook and Pre-Authenticated Login Webhook have been consolidated into the Authenticate Player API. See the introduction for details.
We added a new logo property to the Personalization API. This property is the asset ID of a logo uploaded via the Assets Library. Use it to display a custom logo in your web store.
The new Offer Components API is a suite of APIs that allows you to create and manage the individual elements that make up your web store’s offers, including products, layout designs, and badges.The Offer Components API includes the following:
Offer Designs API: Design the layout of your bundles, special offers, popups, and rolling offers.
Products API: Configure products for your offers, such as virtual or time-based items.
Badges API: Create visual badges in the form of ribbons or emblems to highlight offers.
We added a new playerLocation object to the Player Authentication Webhook request. This object provides information about the player’s location, and includes the following properties:
countryCode: Two-letter country code in ISO-3166 alpha-2 format.
state: Two-letter state code.
This addition makes it easier to apply location-based logic during player authentication.
Events V2 introduces a more structured and consistent format for webhook events, making it easier to parse and integrate. Review the updated schema and validation process in the new documentation.
The new Initiate Refund API allows you to initiate a full refund for a specified order. Upon successful processing, the full amount is reimbursed to the player, and the order status is updated accordingly.
offers.offerDescriptionOverride: Replaces the current offer description in the store UI with a custom description.
offers.productsSequence.products.traits: Defines a list of visual or descriptive features associated with the product, such as bonuses or variants. Each trait includes a text field describing the feature and an assetId referencing the associated asset from your Asset Library.
We added a new attributes property to both the Personalization API and the Create Checkout Session API. This object allows you to define custom key-value pairs to tag players for A/B testing, segmentation, or other use cases. These tags can then be used to filter players in the Publisher Dashboard.
The iOS Mobile Checkout SDK is now available for Unity iOS. The SDK makes it easy to add the iOS Payment Links feature to your app. Instead of relying on traditional in-app purchases, players can buy items like coin packs, character skins, or bundles through a fast, mobile-optimized checkout page.
We added a new offers.productsSequence.products.endsIn property to the Personalization API. This property indicates how much time remains before an offer expires, using an epoch timestamp in milliseconds.
The new iOS Mobile Checkout SDK allows you to easily integrate a mobile checkout experience directly into your iOS game. Instead of relying on traditional in-app purchases, players can buy items like coin packs, character skins, or bundles through a fast, mobile-optimized checkout page.
We added a new paymentPriceInDollar property to Grant Award Callback. 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.
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.
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.The Auto-Update SDK is available for Android and Unity.
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.
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.
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:
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 Grant Award Callback. This allows you to track the origin of your players, the channels they came through, and the campaigns that brought them in.
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.
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.
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.
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 the amountBeforeSale property.
The dynamicOfferUi property is deprecated. Sending this in the payload will result in failure:
dynamicOfferUi.badges → moved to root as badges
dynamicOfferUi.salePercentage → moved to productSale.salePercentage
dynamicOfferUi.salePercentageType → moved to productSale.salePercentageType
The intervals property is deprecated. Use the schedule property instead.
The coolDownInHours property is deprecated.
The publisherSectionId property is now only relevant for the Bundles 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:
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.
