Order Events

Monitor the lifecycle of orders, including creation, payment success or failure, completion, and cancellation.

order_created

timestampRequired

Number

The time when the event occurred.

Example 1632345000

appChargePaymentIdRequired

String

The Appcharge payment ID for the event.

Example pay_12345

appChargeOrderIdRequired

String

The Appcharge order ID for the event.

Example order_12345

playerIdRequired

String

The unique identifier of the player involved in the order.

Example player_12345

sessionMetadata

Object

Additional session data sent during Authentication or Data Sync.

Example {"device": "mobile", "region": "US"}

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

offerRequired

Object

Details about the offer associated with the order.

Offer Details

offerName

String

The name of the offer.

Example Special Bundle

offerInternalId

String

The Appcharge offer ID.

Example offer_12345

offerExternalId

String

The publisher's offer ID.

Example ext_offer_12345

originalPriceInDollar

Number

The base price of the offer in USD.

Example 10.00

country

String

The ISO 3166-1 alpha-2 country code of the player.

Example US

currency

String

The ISO 4217 currency code used for the payment.

Example USD

priceInDollar

Number

The paid price without taxes, converted to USD in real-time.

Example 8.00

priceInCents

Number

The paid price in local currency (in cents).

Example 800

subtotal

Number

The price paid by the player in local currency, excluding taxes.

Example 750

tax

Number

The tax amount paid by the player (in cents of local currency).

Example 50

promoCodeName

String

The name of the promo code being applied.

Example PROMO10

discount

Float

The discount amount in the currency the order was placed in.

Example 1.00

discountRatePoints

String

The rate of the discount as a percentage.

Example 10%

products

Array

A list of products included in the offer.

Product Details

name

String

The name of the product.

Example Deluxe Skin

sku

String

The publisher's product ID.

Example prod_12345

amount

Number

The quantity of the purchased product.

Example 1

Example Payload

Here is an example of what the payload might look like:


{
    "timestamp": 1632345000,
    "appChargePaymentId": "pay_12345",
    "appChargeOrderId": "order_12345",
    "playerId": "player_12345",
    "sessionMetadata": {"device": "mobile", "region": "US"},
    "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
            }
        ]
    }
}

payment_intent_success

timestampRequired

Number

The time when the event occurred.

Example 1632345000

appChargePaymentIdRequired

String

The Appcharge payment ID for the event.

Example pay_12345

appChargeOrderIdRequired

String

The Appcharge order ID for the event.

Example order_12345

playerIdRequired

String

The unique identifier of the player involved in the order.

Example player_12345

sessionMetadata

Object

Additional session data sent during Authentication or Data Sync.

Example {"device": "mobile", "region": "US"}

paymentMethod

String

The payment method used for the transaction.

Example card

estimatedPublisherNetAmount

Number

The estimated amount the publisher receives after all deductions.

Example 7.50

estimatedAppchargeFee

Number

The estimated Appcharge fee for the transaction.

Example 0.50

isSavedPaymentMethodUsed

Boolean

Indicates if a player used/tried to use a saved card to pay in the checkout.

Example True

isNewPaymentMethodSaved

Boolean

Indicates if a player has saved/tried to save a new card during the payment.

Example True

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

offerRequired

Object

Details about the offer associated with the order.

Offer Details

offerName

String

The name of the offer.

Example Special Bundle

offerInternalId

String

The Appcharge offer ID.

Example offer_12345

offerExternalId

String

The publisher's offer ID.

Example ext_offer_12345

originalPriceInDollar

Number

The base price of the offer in USD.

Example 10.00

country

String

The ISO 3166-1 alpha-2 country code of the player.

Example US

currency

String

The ISO 4217 currency code used for the payment.

Example USD

priceInDollar

Number

The paid price without taxes, converted to USD in real-time.

Example 8.00

priceInCents

Number

The paid price in local currency (in cents).

Example 800

subtotal

Number

The price paid by the player in local currency, excluding taxes.

Example 750

tax

Number

The tax amount paid by the player (in cents of local currency).

Example 50

promoCodeName

String

The name of the promo code being applied.

Example PROMO10

discount

Float

The discount amount in the currency the order was placed in.

Example 1.00

discountRatePoints

String

The rate of the discount as a percentage.

Example 10%

products

Array

A list of products included in the offer.

Product Details

name

String

The name of the product.

Example Deluxe Skin

sku

String

The publisher's product ID.

Example prod_12345

amount

Number

The quantity of the purchased product.

Example 1

Example Payload

Here is an example of what the payload might look like:


{
    "timestamp": 1632345000,
    "appChargePaymentId": "pay_12345",
    "appChargeOrderId": "order_12345",
    "playerId": "player_12345",
    "sessionMetadata": {"device": "mobile", "region": "US"},
    "paymentMethod": "card",
    "estimatedPublisherNetAmount": "7.50",
    "estimatedAppchargeFee": "0.50",
    "isSavedPaymentMethodUsed": "True",
    "isNewPaymentMethodSaved": "True",
    "reason": "insufficient_funds",
    "pricePointMetadata": "800",
    "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
            }
        ]
    }
}

payment_intent_failed

timestampRequired

Number

The time when the event occurred.

Example 1632345000

appChargePaymentIdRequired

String

The Appcharge payment ID for the event.

Example pay_12345

appChargeOrderIdRequired

String

The Appcharge order ID for the event.

Example order_12345

playerIdRequired

String

The unique identifier of the player involved in the order.

Example player_12345

sessionMetadata

Object

Additional session data sent during Authentication or Data Sync.

Example {"device": "mobile", "region": "US"}

paymentMethod

String

The payment method used for the transaction.

Example credit_card

isSavedPaymentMethodUsed

Boolean

Indicates if a player used/tried to use a saved card to pay in the checkout.

Example True

isNewPaymentMethodSaved

Boolean

Indicates if a player has saved/tried to save a new card during the payment.

Example True

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

offerRequired

Object

Details about the offer associated with the order.

Offer Details

offerName

String

The name of the offer.

Example Special Bundle

offerInternalId

String

The Appcharge offer ID.

Example offer_12345

offerExternalId

String

The publisher's offer ID.

Example ext_offer_12345

originalPriceInDollar

Number

The base price of the offer in USD.

Example 10.00

country

String

The ISO 3166-1 alpha-2 country code of the player.

Example US

currency

String

The ISO 4217 currency code used for the payment.

Example USD

priceInDollar

Number

The paid price without taxes, converted to USD in real-time.

Example 8.00

priceInCents

Number

The paid price in local currency (in cents).

Example 800

subtotal

Number

The price paid by the player in local currency, excluding taxes.

Example 750

tax

Number

The tax amount paid by the player (in cents of local currency).

Example 50

promoCodeName

String

The name of the promo code being applied.

Example PROMO10

discount

Float

The discount amount in the currency the order was placed in.

Example 1.00

discountRatePoints

String

The rate of the discount as a percentage.

Example 10%

products

Array

A list of products included in the offer.

Product Details

name

String

The name of the product.

Example Deluxe Skin

sku

String

The publisher's product ID.

Example prod_12345

amount

Number

The quantity of the purchased product.

Example 1

Example Payload

Here is an example of what the payload might look like:


{
    "timestamp": 1632345000,
    "appChargePaymentId": "pay_12345",
    "appChargeOrderId": "order_12345",
    "playerId": "player_12345",
    "sessionMetadata": {"device": "mobile", "region": "US"},
    "paymentMethod": "credit_card",
   	"isSavedPaymentMethodUsed": "True",
    "isNewPaymentMethodSaved": "True",
    "reason": "insufficient_funds",
   	"pricePointMetadata": "800",
    "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
            }
        ]
    }
}

order_completed_success

timestampRequired

Number

The time when the event occurred.

Example 1632345000

appChargePaymentIdRequired

String

The Appcharge payment ID for the event.

Example pay_12345

appChargeOrderIdRequired

String

The Appcharge order ID for the event.

Example order_12345

playerIdRequired

String

The unique identifier of the player involved in the order.

Example player_12345

sessionMetadata

Object

Additional session data sent during Authentication or Data Sync.

Example {"device": "mobile", "region": "US"}

paymentMethod

String

The payment method used for the transaction.

Example credit_card

estimatedPublisherNetAmount

Number

The estimated amount the publisher receives after all deductions.

Example 7.50

estimatedAppchargeFee

Number

The estimated Appcharge fee for the transaction.

Example 0.50

isSavedPaymentMethodUsed

Boolean

Indicates if a player used/tried to use a saved card to pay in the checkout.

Example True

isNewPaymentMethodSaved

Boolean

Indicates if a player has saved/tried to save a new card during the payment.

Example True

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

offerRequired

Object

Details about the offer associated with the order.

Offer Details

offerName

String

The name of the offer.

Example Special Bundle

offerInternalId

String

The Appcharge offer ID.

Example offer_12345

offerExternalId

String

The publisher's offer ID.

Example ext_offer_12345

originalPriceInDollar

Number

The base price of the offer in USD.

Example 10.00

country

String

The ISO 3166-1 alpha-2 country code of the player.

Example US

currency

String

The ISO 4217 currency code used for the payment.

Example USD

priceInDollar

Number

The paid price without taxes, converted to USD in real-time.

Example 8.00

priceInCents

Number

The paid price in local currency (in cents).

Example 800

subtotal

Number

The price paid by the player in local currency, excluding taxes.

Example 750

tax

Number

The tax amount paid by the player (in cents of local currency).

Example 50

promoCodeName

String

The name of the promo code being applied.

Example PROMO10

discount

Float

The discount amount in the currency the order was placed in.

Example 1.00

discountRatePoints

String

The rate of the discount as a percentage.

Example 10%

products

Array

A list of products included in the offer.

Product Details

name

String

The name of the product.

Example Deluxe Skin

sku

String

The publisher's product ID.

Example prod_12345

amount

Number

The quantity of the purchased product.

Example 1

Example Payload

Here is an example of what the payload might look like:


{
    "timestamp": 1632345000,
    "appChargePaymentId": "pay_12345",
    "appChargeOrderId": "order_12345",
    "playerId": "player_12345",
    "sessionMetadata": {"device": "mobile", "region": "US"},
    "paymentMethod": "credit_card",
    "estimatedPublisherNetAmount": "7.50",
    "estimatedAppchargeFee": "0.50",
    "isSavedPaymentMethodUsed": "True",
    "isNewPaymentMethodSaved": "True",
    "reason": "insufficient_funds",
    "pricePointMetadata": "800",
    "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
            }
        ]
    }
}

order_completed_failed

timestampRequired

Number

The time when the event occurred.

Example 1632345000

appChargePaymentIdRequired

String

The Appcharge payment ID for the event.

Example pay_12345

appChargeOrderIdRequired

String

The Appcharge order ID for the event.

Example order_12345

playerIdRequired

String

The unique identifier of the player involved in the order.

Example player_12345

sessionMetadata

Object

Additional session data sent during Authentication or Data Sync.

Example {"device": "mobile", "region": "US"}

paymentMethod

String

The payment method used for the transaction.

Example 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

offerRequired

Object

Details about the offer associated with the order.

Offer Details

offerName

String

The name of the offer.

Example Special Bundle

offerInternalId

String

The Appcharge offer ID.

Example offer_12345

offerExternalId

String

The publisher's offer ID.

Example ext_offer_12345

originalPriceInDollar

Number

The base price of the offer in USD.

Example 10.00

country

String

The ISO 3166-1 alpha-2 country code of the player.

Example US

currency

String

The ISO 4217 currency code used for the payment.

Example USD

priceInDollar

Number

The paid price without taxes, converted to USD in real-time.

Example 8.00

priceInCents

Number

The paid price in local currency (in cents).

Example 800

subtotal

Number

The price paid by the player in local currency, excluding taxes.

Example 750

tax

Number

The tax amount paid by the player (in cents of local currency).

Example 50

promoCodeName

String

The name of the promo code being applied.

Example PROMO10

discount

Float

The discount amount in the currency the order was placed in.

Example 1.00

discountRatePoints

String

The rate of the discount as a percentage.

Example 10%

products

Array

A list of products included in the offer.

Product Details

name

String

The name of the product.

Example Deluxe Skin

sku

String

The publisher's product ID.

Example prod_12345

amount

Number

The quantity of the purchased product.

Example 1

Example Payload

Here is an example of what the payload might look like:


{
    "timestamp": 1632345000,
    "appChargePaymentId": "pay_12345",
    "appChargeOrderId": "order_12345",
    "playerId": "player_12345",
    "sessionMetadata": {"device": "mobile", "region": "US"},
    "paymentMethod": "card",
    "reason": "insufficient_funds",
    "pricePointMetadata": "800",
    "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
            }
        ]
    }
}

order_cancelled

timestampRequired

Number

The time when the event occurred.

Example 1632345000

appChargePaymentIdRequired

String

The Appcharge payment ID for the event.

Example pay_12345

appChargeOrderIdRequired

String

The Appcharge order ID for the event.

Example order_12345

playerIdRequired

String

The unique identifier of the player involved in the order.

Example player_12345

sessionMetadata

Object

Additional session data sent during Authentication or Data Sync.

Example {"device": "mobile", "region": "US"}

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

offerRequired

Object

Details about the offer associated with the order.

Offer Details

offerName

String

The name of the offer.

Example Special Bundle

offerInternalId

String

The Appcharge offer ID.

Example offer_12345

offerExternalId

String

The publisher's offer ID.

Example ext_offer_12345

originalPriceInDollar

Number

The base price of the offer in USD.

Example 10.00

country

String

The ISO 3166-1 alpha-2 country code of the player.

Example US

currency

String

The ISO 4217 currency code used for the payment.

Example USD

priceInDollar

Number

The paid price without taxes, converted to USD in real-time.

Example 8.00

priceInCents

Number

The paid price in local currency (in cents).

Example 800

subtotal

Number

The price paid by the player in local currency, excluding taxes.

Example 750

tax

Number

The tax amount paid by the player (in cents of local currency).

Example 50

promoCodeName

String

The name of the promo code being applied.

Example PROMO10

discount

Float

The discount amount in the currency the order was placed in.

Example 1.00

discountRatePoints

String

The rate of the discount as a percentage.

Example 10%

products

Array

A list of products included in the offer.

Product Details

name

String

The name of the product.

Example Deluxe Skin

sku

String

The publisher's product ID.

Example prod_12345

amount

Number

The quantity of the purchased product.

Example 1

Example Payload

Here is an example of what the payload might look like:


{
    "timestamp": 1632345000,
    "appChargePaymentId": "pay_12345",
    "appChargeOrderId": "order_12345",
    "playerId": "player_12345",
    "sessionMetadata": {"device": "mobile", "region": "US"},
    "paymentMethod": "credit_card",
    "reason": "insufficient_funds",
   	"pricePointMetadata": "800",
    "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
            }
        ]
    }
}