Order Completed

{
  "eventName": "order.completed",
  "eventId": "3f5bffbc-369e-4599-8c4d-abfe0ae0ef96",
  "timestamp": 1754307361396,
  "sessionId": "345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
  "requestId": "23539478-c744-566a-c78c-c4cc7763ff62",
  "result": "success",
  "reason": null,
  "attributes": {
    "persona": "non_payer",
    "blackFridayTest": "Base_group"
  },
  "customer": {
    "id": "671e81bb-55ef-428b-97ba-f67783971e0d",
    "name": null,
    "email": null
  },
  "offer": {
    "externalId": "22ae81bb-55ef-428b-97ba-f67783971e4a",
    "type": "PopUp",
    "subType": "DailyBonus",
    "name": "Spring Is Here",
    "offerIndex": 1,
    "indexToCollect": 1,
    "tab": "Tab 1",
    "pricePoint": 800,
    "price": 800,
    "currencyCode": "USD",
    "products": [
      {
        "displayName": "Gold Coins",
        "productExternalId": "31ae81bb-55ef-428b-97ba-f67783971e553",
        "productQuantity": "1000"
      },
      {
        "displayName": "Silver Shield",
        "productExternalId": "9af1abb-55ef-428b-97ba-f677839716ac9",
        "productQuantity": "40"
      }
    ]
  },
  "order": {
    "id": "695b72ff0e34d3a514b6eda0",
    "orderType": "Paid",
    "subtotal": 77700,
    "discountAmount": -7770,
    "totalPayment": 76136,
    "taxAmount": 6206,
    "currencyCode": "USD",
    "currencySymbol": "$",
    "paymentMethod": "Credit Card",
    "isSavedPaymentMethodUsed": true,
    "isNewPaymentMethodSaved": true,
    "pricePointMetadata": 77700
  },
  "coupon": {
    "name": "Birthday Promo",
    "promoCodeName": "BIRTHDAY10",
    "discount": -7770,
    "discountPercentage": 10
  },
  "storeMetadata": {
    "offerType": "Bundle",
    "offersSequenceIndex": 1,
    "landingUrl": "https://store.example.com/?myParam=ABC123"
  },
  "device": {
    "platform": null,
    "deviceModel": null,
    "osType": "Apple",
    "osVersion": "18",
    "browserType": "Google Chrome",
    "browserVersion": "138"
  },
  "geolocation": {
    "countryCode2": "US",
    "region": null,
    "ipAddress": null,
    "zipCode": null
  },
  "transactions": [
    {
      "purchaseId": "pr_abbd0d529dea49f9a7adde2c3827c576",
      "type": "paid",
      "timestamp": 1767600954414,
      "amount": 76136,
      "amountUsd": 2506,
      "totalTaxAmount": 6206,
      "totalTaxAmountUsd": 6206,
      "currencyExchangeCostUsd": 0,
      "chargeBackFeeUsd": 20
    }
  ],
  "sessionMetadata": { "abTest": "group1", "locale": "en-US" }
}

{
  "eventName": "order.completed",
  "eventId": "3f5bffbc-369e-4599-8c4d-abfe0ae0ef96",
  "timestamp": 1754307361396,
  "sessionId": "345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
  "requestId": "23539478-c744-566a-c78c-c4cc7763ff62",
  "result": "success",
  "reason": null,
  "attributes": {
    "persona": "non_payer",
    "blackFridayTest": "Base_group"
  },
  "customer": {
    "id": "671e81bb-55ef-428b-97ba-f67783971e0d",
    "name": null,
    "email": null
  },
  "offer": {
    "externalId": "22ae81bb-55ef-428b-97ba-f67783971e4a",
    "type": "PopUp",
    "subType": "DailyBonus",
    "name": "Spring Is Here",
    "offerIndex": 1,
    "indexToCollect": 1,
    "tab": "Tab 1",
    "pricePoint": 800,
    "price": 800,
    "currencyCode": "USD",
    "products": [
      {
        "displayName": "Gold Coins",
        "productExternalId": "31ae81bb-55ef-428b-97ba-f67783971e553",
        "productQuantity": "1000"
      },
      {
        "displayName": "Silver Shield",
        "productExternalId": "9af1abb-55ef-428b-97ba-f677839716ac9",
        "productQuantity": "40"
      }
    ]
  },
  "order": {
    "id": "695b72ff0e34d3a514b6eda0",
    "orderType": "Paid",
    "subtotal": 77700,
    "discountAmount": -7770,
    "totalPayment": 76136,
    "taxAmount": 6206,
    "currencyCode": "USD",
    "currencySymbol": "$",
    "paymentMethod": "Credit Card",
    "isSavedPaymentMethodUsed": true,
    "isNewPaymentMethodSaved": true,
    "pricePointMetadata": 77700
  },
  "coupon": {
    "name": "Birthday Promo",
    "promoCodeName": "BIRTHDAY10",
    "discount": -7770,
    "discountPercentage": 10
  },
  "storeMetadata": {
    "offerType": "Bundle",
    "offersSequenceIndex": 1,
    "landingUrl": "https://store.example.com/?myParam=ABC123"
  },
  "device": {
    "platform": null,
    "deviceModel": null,
    "osType": "Apple",
    "osVersion": "18",
    "browserType": "Google Chrome",
    "browserVersion": "138"
  },
  "geolocation": {
    "countryCode2": "US",
    "region": null,
    "ipAddress": null,
    "zipCode": null
  },
  "transactions": [
    {
      "purchaseId": "pr_abbd0d529dea49f9a7adde2c3827c576",
      "type": "paid",
      "timestamp": 1767600954414,
      "amount": 76136,
      "amountUsd": 2506,
      "totalTaxAmount": 6206,
      "totalTaxAmountUsd": 6206,
      "currencyExchangeCostUsd": 0,
      "chargeBackFeeUsd": 20
    }
  ],
  "sessionMetadata": { "abTest": "group1", "locale": "en-US" }
}

An event triggered when an order is successfully paid and processed, and confirmation is sent to the publisher or game. Event Data

string

Event name: order.completed.

string

Event ID. Use this ID to deduplicate re-delivered events.

number

Event timestamp in Epoch time, represented in milliseconds. Example: 1754307361396.

string

The session ID of the player’s current session. Example: 345397c6-d963-4aa4-a0ba-2aaca6c3ee05.

string

ID assigned by Appcharge to each request sent to the publisher. Helps the publisher identify and debug failed requests.

string

Event result. Supported values: success, failed.

string

Reason for the event result. When result is success, this field returns null. When result is failed and the player wasn’t charged, this field returns Checkout failed. When result is failed after a successful charge, this field returns Publisher failed to award, or Publisher failed to award: followed by the publisher error message.

map<any,any>

A key-value map used to label events for tracking personas or tests. Example: { "persona":"non_payer", "blackFridayTest":"Base_group" }

object

Information about the player.

Show properties

string

Customer ID.

string

Deprecated. Player’s email address.

string

Deprecated. Reserved for the player’s name in future versions.

object

Information about the offer.

Show properties

string

External ID of the offer as configured in the Publisher Dashboard.

string

Offer type.

string

Offer subtype.

string

Offer name.

number

The index of the offer.

number

Deprecated. Reserved for the index to collect in future versions.

string

Deprecated. Reserved for the Publisher Dashboard tab name in future versions.

number

Price point of the offer in USD cents.

number

Price in lowest currency unit. For example, cents for USD, and whole yen for JPY. For a list of of supported currencies, their minor unit types, and applicable pricing limitations, see Supported Currencies.

string

Currency code of the offer in ISO_4217 format.

[object]

List of products in an offer.

Show properties

string

Display name of the product.

string

External ID of the product as configured in the Publisher Dashboard.

string

The quantity of the product. Must be a minimum 0 and equal to or less than 24 digits long.

object

Show properties

string

Order ID.

string

Order type. Example: Paid.

int

Total order amount in the player’s local currency, excluding taxes and discounts.

int

Discount amount calculated on the tax-exclusive price, in USD cents. Always negative, representing a reduction. Example: -7770

int

Total amount paid by the player, including discounts and taxes in the player’s local currency.

int

Tax amount in the player’s local currency.

string

Currency code in ISO_4217 format.

string

Currency symbol.

string

Payment method used for the order.

number

The price point in USD cents. Example: 77700.

boolean

Whether a player attempted to pay using a saved payment method.

boolean

Whether a player attempted to save a new payment method in the checkout.

object

Show properties

number

Index of the sub-offer within an offer.

string

Offer type.

string

URL the player used to land on the web store in the current active session. The URL is propagated as is, from the web store session to the checkout. Example: https://store.example.com/?myParam=ABC123.

object

Information about the coupon.

Show properties

string

Coupon name.

Promo code name.

float

Discount amount calculated on the tax-exclusive price, in USD cents. Always negative, representing a reduction. Example: -7770

float

Discount percentage.

object

Information about the player’s device.

Show properties

string

Device platform. Currently returns null.

string

Device model. Currently returns null.

string

Operating system type. Example: Android.

string

Operating system version. Example: 18.

string

Browser type. Example: Google Chrome.

string

Browser version. Example: 138.

object

Information about the player’s geolocation.

Show properties

enum

Two-letter country code in ISO-3166 alpha-2 format. Example: US

string

Deprecated. Region or state.

string

Deprecated. IP address in IPv4 format. Example: 80.178.249.122.

string

Deprecated. Zip code.

[object]

Information about each transaction.

Show properties

string

Purchase ID.

string

Transaction type.

number

Transaction timestamp in Epoch time. Example: 1754307361396.

number

Transaction amount in the player’s local currency.

number

Transaction amount in USD cents. Example: 76136.

number

Tax amount in the player’s local currency.

number

Tax amount in USD cents. Example: 6206.

number

Currency exchange fee in USD cents.

number

Chargeback fee in USD cents. Example: 20.

any

Session metadata for passing data to Appcharge to be returned later.

{
  "eventName": "order.completed",
  "eventId": "3f5bffbc-369e-4599-8c4d-abfe0ae0ef96",
  "timestamp": 1754307361396,
  "sessionId": "345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
  "requestId": "23539478-c744-566a-c78c-c4cc7763ff62",
  "result": "success",
  "reason": null,
  "attributes": {
    "persona": "non_payer",
    "blackFridayTest": "Base_group"
  },
  "customer": {
    "id": "671e81bb-55ef-428b-97ba-f67783971e0d",
    "name": null,
    "email": null
  },
  "offer": {
    "externalId": "22ae81bb-55ef-428b-97ba-f67783971e4a",
    "type": "PopUp",
    "subType": "DailyBonus",
    "name": "Spring Is Here",
    "offerIndex": 1,
    "indexToCollect": 1,
    "tab": "Tab 1",
    "pricePoint": 800,
    "price": 800,
    "currencyCode": "USD",
    "products": [
      {
        "displayName": "Gold Coins",
        "productExternalId": "31ae81bb-55ef-428b-97ba-f67783971e553",
        "productQuantity": "1000"
      },
      {
        "displayName": "Silver Shield",
        "productExternalId": "9af1abb-55ef-428b-97ba-f677839716ac9",
        "productQuantity": "40"
      }
    ]
  },
  "order": {
    "id": "695b72ff0e34d3a514b6eda0",
    "orderType": "Paid",
    "subtotal": 77700,
    "discountAmount": -7770,
    "totalPayment": 76136,
    "taxAmount": 6206,
    "currencyCode": "USD",
    "currencySymbol": "$",
    "paymentMethod": "Credit Card",
    "isSavedPaymentMethodUsed": true,
    "isNewPaymentMethodSaved": true,
    "pricePointMetadata": 77700
  },
  "coupon": {
    "name": "Birthday Promo",
    "promoCodeName": "BIRTHDAY10",
    "discount": -7770,
    "discountPercentage": 10
  },
  "storeMetadata": {
    "offerType": "Bundle",
    "offersSequenceIndex": 1,
    "landingUrl": "https://store.example.com/?myParam=ABC123"
  },
  "device": {
    "platform": null,
    "deviceModel": null,
    "osType": "Apple",
    "osVersion": "18",
    "browserType": "Google Chrome",
    "browserVersion": "138"
  },
  "geolocation": {
    "countryCode2": "US",
    "region": null,
    "ipAddress": null,
    "zipCode": null
  },
  "transactions": [
    {
      "purchaseId": "pr_abbd0d529dea49f9a7adde2c3827c576",
      "type": "paid",
      "timestamp": 1767600954414,
      "amount": 76136,
      "amountUsd": 2506,
      "totalTaxAmount": 6206,
      "totalTaxAmountUsd": 6206,
      "currencyExchangeCostUsd": 0,
      "chargeBackFeeUsd": 20
    }
  ],
  "sessionMetadata": { "abTest": "group1", "locale": "en-US" }
}

Overview

What's New

Web Store

Checkout

Game Portal

Media

Events Center

Translations