Logging purchases

Learn how to log in-app purchases through the Braze SDK, so you can determine your revenue over-time and across sources. This will let you segment users based on their lifetime value using custom events, custom attributes, and purchase events.

note:

For wrapper SDKs not listed, use the relevant native Android or Swift method instead.

Logging purchases and revenue

To log purchases and revenue, call logPurchase() after a successful purchase in your app. If the product Identifier is empty, the purchase will not be logged to Braze.

java
kotlin

Braze.getInstance(context).logPurchase(
   String productId,
   String currencyCode,
   BigDecimal price,
   int quantity
);

Braze.getInstance(context).logPurchase(
  productId: String,
  currencyCode: String,
  price: BigDecimal,
  quantity: Int
)

swift
objective-c

AppDelegate.braze?.logPurchase(productID: "product_id", currency: "USD", price: price)

[AppDelegate.braze logPurchase:"product_id"
                      currency:@"USD"
                         price:price];

For a standard Web SDK implementation, you can use the following method:

braze.logPurchase(product_id, price, "USD", quantity);

If you’d like to use Google Tag Manager instead, you can use the Purchase tag type to call the logPurchase method . Use this tag to track purchases to Braze, optionally including purchase properties. To do so:

The Product ID and Price fields are required.
Use the Add Row button to add purchase properties.

A dialog box showing the Braze Action Tag configuration settings. Settings included are "tag type", "external ID", "price", "currency code", "quantity", and "purchase properties".

var properties = {};
properties["KEY"] = "VALUE";
BrazePlugin.logPurchase("PRODUCT_ID", 10, "USD", 5, properties);

braze.logPurchase(productId, currencyCode, price, quantity, properties: properties);

Braze.logPurchase(productId, price, currencyCode, quantity, properties);

m.Braze.logPurchase("product_id", "currency_code", Double price, Integer quantity)

AppboyBinding.LogPurchase("product_id", "currencyCode", price(decimal));

UBraze->LogPurchase(TEXT("product_id"), TEXT("USD"), price, quantity);

warning:

productID can only have a maximum of 255 characters. Addtionally, if the product identifier is empty, the purchase will not be logged to Braze.

Adding properties

You can add metadata about purchases by passing a Dictionary populated with Int, Double, String, Bool, or Date values.

java
kotlin

BrazeProperties purchaseProperties = new BrazeProperties();
purchaseProperties.addProperty("key", "value");
Braze.getInstance(context).logPurchase(..., purchaseProperties);

val purchaseProperties = BrazeProperties()
purchaseProperties.addProperty("key", "value")
Braze.getInstance(context).logPurchase(..., purchaseProperties)

swift
objective-c

let purchaseProperties = ["key": "value"]
AppDelegate.braze?.logPurchase(productID: "product_id", currency: "USD", price: price, properties: purchaseProperties)

NSDictionary *purchaseProperties = @{@"key": @"value"};
[AppDelegate.braze logPurchase:@"product_id"
                      currency:@"USD"
                         price:price
                   properties:purchaseProperties];

For a standard Web SDK implementation, you can use the following method:

braze.logPurchase(product_id, price, "USD", quantity, {key: "value"});

If your site logs purchases using the standard ecommerce event data layer item to Google Tag Manager, then you can use the E-commerce Purchase tag type. This action type will log a separate “purchase” in Braze for each item sent in the list of items.

You can also specify additional property names you want to include as purchase properties by specifying their keys in the Purchase properties list. Note that Braze will look within the individual item that is being logged for any purchase properties you add to the list.

For example, given the following ecommerce payload:

1
2
3
4
5
6
7
items: [{
  item_name: "5 L WIV ECO SAE 5W/30",
  item_id: "10801463",
  price: 24.65,
  item_brand: "EUROLUB",
  quantity: 1
}]

If you only want item_brand and item_name to be passed as purchase properties, then just add those two fields to the purchase properties table. If you don’t supply any properties, then no purchase properties will be sent in the logPurchase call to Braze.

var properties = {};
properties["key"] = "value";
BrazePlugin.logPurchase("PRODUCT_ID", 10, "USD", 5, properties);

braze.logPurchase(productId, currencyCode, price, quantity, properties: {"key": "value"});

Braze.logPurchase(productId, price, currencyCode, quantity, { key: "value" });

m.Braze.logPurchase("product_id", "currency_code", Double price, Integer quantity, {"stringPropKey" : "stringPropValue", "intPropKey" : Integer intPropValue})

Dictionary<string, object> purchaseProperties = new Dictionary<string, object>
{
    { "key", "value" }
};
AppboyBinding.LogPurchase("product_id", "currencyCode", price(decimal), purchaseProperties);

TMap<FString, FString> PurchaseProperties;
PurchaseProperties.Add(TEXT("key"), TEXT("value"));

UBraze->LogPurchaseWithProperties(TEXT("product_id"), TEXT("USD"), price, quantity, PurchaseProperties);

Adding quantity

By default, quantity is set to 1. However, you can add a quantity to your purchases if customers make the same purchase multiple times in a single checkout. To add a quantity, pass an Int value to quantity that’s within the range of [0, 100].

Using the REST API

You can also use our REST API to record purchases. For more information, refer to User Data Endpoints.

Logging orders

If you want to log purchases at the order level instead of the product level, you can use order name or order category as the product_id. Refer to our purchase object specification to learn more.

Reserved keys

The following keys are reserved and cannot be used as purchase properties:

time
product_id
quantity
event_name
price
currency

Supported currencies

These are the supported currency symbols. Any other currency symbol you provide will log a warning and the purchase will not be logged to Braze.

USD
CAD
EUR
GBP
JPY
AUD
CHF
NOK
MXN
NZD
CNY
RUB
TRY
INR
IDR
ILS
SAR
ZAR
AED
SEK
HKD
SPD
DKK

Edit this page on GitHub

HOW HELPFUL WAS THIS PAGE?

Logging Custom Events

Tracking Sessions

Edit this page on GitHub

New Stuff!