{ 
  "timestamp": 1632345000, 
  "appChargePaymentId": "pay_12345", 
  "appChargeOrderId": "order_12345", 
  "playerId": "player_12345", 
  "sessionMetadata": {
    "device": "mobile", 
    "region": "US"
  }, 
  "storeMetadata": { 
    "productsSequenceIndex": 1 
  }, 
  "paymentMethod": "credit_card", 
  "reason": "insufficient_funds", 
  "pricePointMetadata": "The base price of the price point." 
  "offer": { 
    "offerName": "Special Bundle", 
    "offerInternalId": "offer_12345", 
    "offerExternalId": "ext_offer_12345", 
    "originalPriceInDollar": 10.00, 
    "country": "US", 
    "currency": "USD", 
    "priceInDollar": 8.00, 
    "priceInCents": 800, 
    "subtotal": 750, 
    "tax": 50, 
    "promoCodeName": "PROMO10", 
    "discount": 1.00, 
    "discountRatePoints": "10%", 
    "products": [
      { 
        "name": "Deluxe Skin", 
        "sku": "prod_12345", 
        "amount": 1 
      }
    ] 
  } 
}

An event triggered when a new order session is initialized, either from the web store or via direct API call.

Event Data

​
timestamp
number

The time when the event occurred. Example: 1632345000

​
appChargePaymentId
string

The Appcharge payment ID for the event. Example: pay_12345

​
appChargeOrderId
string

The Appcharge order ID for the event. Example: order_12345

​
playerId
string

The unique identifier of the player involved in the order. Example: player_12345

​
sessionMetadata
object

Relevant only to Personalization API users, the player session metadata object received from the Personalization API. Example: { "metadata": "data" }

​
storeMetadata
object

Details on offer-related metadata.

​
paymentMethod
string

The payment method used for the transaction. Example: credit_card

​
reason
string

Error reason in case of a failure. Example: insufficient_funds

​
pricePointMetadata
number

The base price of the price point in USD cents. Example: 800

​
offer
object

Details about the offer associated with the order.

{ 
  "timestamp": 1632345000, 
  "appChargePaymentId": "pay_12345", 
  "appChargeOrderId": "order_12345", 
  "playerId": "player_12345", 
  "sessionMetadata": {
    "device": "mobile", 
    "region": "US"
  }, 
  "storeMetadata": { 
    "productsSequenceIndex": 1 
  }, 
  "paymentMethod": "credit_card", 
  "reason": "insufficient_funds", 
  "pricePointMetadata": "The base price of the price point." 
  "offer": { 
    "offerName": "Special Bundle", 
    "offerInternalId": "offer_12345", 
    "offerExternalId": "ext_offer_12345", 
    "originalPriceInDollar": 10.00, 
    "country": "US", 
    "currency": "USD", 
    "priceInDollar": 8.00, 
    "priceInCents": 800, 
    "subtotal": 750, 
    "tax": 50, 
    "promoCodeName": "PROMO10", 
    "discount": 1.00, 
    "discountRatePoints": "10%", 
    "products": [
      { 
        "name": "Deluxe Skin", 
        "sku": "prod_12345", 
        "amount": 1 
      }
    ] 
  } 
}