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.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.sessionId
property to Store Interaction Events, allowing you to identify the player session associated with each event.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
.quantityDisplay
property to items
object in the Create Checkout Session API. This property overrides the quantity
value displayed in the checkout.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.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
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.
playerLevelBanners
object to the Player Info Sync Webhook, allowing you to dynamically display specific banners to players based on their game level.productSale
object includes the amountBeforeSale
property.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
intervals
property is deprecated. Use the schedule
property instead.coolDownInHours
property is deprecated.publisherSectionId
property is now only relevant for the Bundles API.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.