Skip to main content

Customer Attributes

Attributes are useful for storing additional, structured information on a customer that can be used elsewhere in the system.

For example, you could store your customer's email address or additional system identifiers through the applicable reserved attributes, or store arbitrary facts like onboarding survey responses, feature usage, or other dimensions as custom attributes -- all directly in RevenueCat. Attributes will not be seen by your users unless you choose to explicitly show them yourself.

πŸ“˜Attribute synchronization

By default, attributes are only synced with RevenueCat servers when Purchases.configure() is called, app backgrounded, and when purchases are made or restored. The syncPurchasesAndOfferingsIfNeeded() method should be used if custom attributes are being used for Targeting to ensure immediate syncing. Learn more here.

How Attributes can be used​

  1. Attributes can be fetched via the REST API for individual customers, or reviewed in their Customer Profile in the Dashboard.
  2. Custom attributes can be used via Targeting to define business-specific audiences and deliver them unique Offerings. Learn more.
  3. Attributes are provided in Scheduled Data Exports for use in custom analyses (e.g. to measure Active Subscriptions by Custom Attribute)
⚠️Attributes cannot be fetched from the SDK

For security reasons, attributes cannot be fetched from the SDK. To read attributes, use the REST API with a private API key.

Setting Attributes​

Attributes for a Customer can be set through the SDK by passing a dictionary of strings to the setAttributes() method on the shared Purchases instance.

Purchases.shared.attribution.setAttributes(["age": "24",
"custom_group_id": "abc123"])
⚠️Attributes are not secure storage

Since attributes are writable using a public key they should not be used for managing secure or sensitive information such as subscription status, coins, etc.

Custom attributes​

Custom attributes can be set to track any app-specific fact you want to capture about your customers; like their response to an onboarding survey, whether they've engaged with a certain feature, or the deep link they installed your app from.

πŸ“˜Targeting by Custom Attribute

You can display unique paywalls to different customer segments based on custom attributes. Learn more here.

You can specify up to 50 unique custom attributes per subscriber, with key names up to 40 characters long and values up to 500 characters long. Keys cannot start with $, since that prefix is withheld for reserved attributes (see below).

Custom attribute key checklist:
βœ… Key does not contain whitespace
βœ… Key must start with a letter for non-reserved attributes or "$" for reserved attributes
βœ… Key does not include any non-alphanumeric characters except - and _
βœ… Key is not more than 40 characters
βœ… Value is not more than 500 characters
βœ… No more than 50 custom attributes

Reserved attributes​

Attribute keys beginning with $ are reserved for RevenueCat. The current list of reserved keys are below:

General​

KeyDescription
$displayNameName that should be used to reference the user
$apnsTokensApple push notification tokens for the user.
$fcmTokensGoogle push notification tokens for the user.
$attConsentStatusApple App Tracking Transparency consent status for the user.
$ipAddressIp Address for the user.
$clevertapId Clever Tap ID for the user.
$idfaiOS advertising identifier UUID.
$idfviOS vender identifier UUID.
$gpsAdIdThe advertising ID that is provided by Google Play services.
$androidIdAndroid device identifier.
$amazonAdIdAmazon Advertising ID.
$adjustIdThe unique Adjust identifier for the user.
$amplitudeDeviceIdThe Amplitude Device ID.
$amplitudeUserIdThe Amplitude User ID.
$appsflyerIdAppsflyer Id. The unique Appsflyer identifier for the user.
$brazeAliasNameThe Braze 'alias_name' in User Alias Object.
$brazeAliasLabelThe Braze 'alias_label' in User Alias Object.
$clevertapIdThe CleverTap ID for the user.
$fbAnonIdThe Facebook Anonymous ID for the user.
$attConsentStatusApple App Tracking Transparency consent status for the user.
$mparticleIdThe unique mParticle user identifier (mpid).
$onesignalIdThe OneSignal Player Id for the user.
$airshipChannelIdThe Airship channel ID for the user.
$iterableUserIdThe Iterable ID for the user.
$iterableCampaignIdThe Iterable campaign ID.
$iterableTemplateIdThe Iterable template ID.
$firebaseAppInstanceIdThe Firebase instance identifier.
$mixpanelDistinctIdThe Mixpanel user identifier.
$ipThe IP address of the device.
$emailEmail address for the user.
$phoneNumberPhone number for the user.
⚠️attConsentStatus is populated regardless of requesting any permission

The RevenueCat SDK sends the current ATT status for the $attConsentStatus attribute regardless of if you are or aren't requesting any ATT permission. So just as a heads-up, you can expect to see this attribute filled.

Note: The RevenueCat SDK reads the current App Tracking Transparency Consent Status for the user, but will not modify it or request for further permission.

You may see the following as a response from this attribute:

  • restricted - Can be returned if the user is using a mobile device management profile that disallows some aspects of tracking regardless of consent. This might be returned even if you never ask for permissions.
  • denied - Can be returned if the user’s phone has set β€œAsk Apps Not To Track” in OS Settings or denied access for the specific app.
  • accepted - Returned if you ask for permission and the permission gets accepted by the user.
  • unknown - The user hasn’t set β€œAsk Apps Not to Track” in OS Settings, and you have never asked the user for consent to track activity.

Device Identifiers​

KeyDescription
$idfaApple advertising identifier
$idfvApple vendor identifier
$gpsAdIdGoogle advertising identifier
$androidIdAndroid device identifier
$ipIP Address
πŸ“˜Device identifiers can't be changed once set

Once a device identifier is set for a subscriber, it can't be changed in order to keep these identifiers associated with the original installation. This allows RevenueCat to send events generated by a particular device to downstream integrations with a consistent identifier unaffected by uninstalls and reinstalls.

Third-party Identifiers​

KeyDescription
$adjustIdAdjust user identifier
$amplitudeDeviceIdAmplitude device identifier
$amplitudeUserIdAmplitude user identifier
$appsflyerIdAppsflyer user identifier
$fbAnonIdFacebook SDK anonymous user identifier
$firebaseAppInstanceIdFirebase instance identifier
$iterableUserIdIterable user identifier
$mixpanelDistinctIdMixpanel user identifier
$mparticleIdmParticle user identifier
$onesignalIdOneSignal player identifier
$clevertapIdCleverTap user identifier
$airshipChannelIdAirship channel identifier

Braze User Alias Object​

KeyDescription
$brazeAliasNameBraze 'alias_name' in User Alias Object
$brazeAliasLabelBraze 'alias_label' in User Alias Object

Iterable Data​

Key
$iterableCampaignId
$iterableTemplateId

Attribution Data​

Key
$mediaSource
$campaign
$adGroup
$ad
$keyword
$creative
πŸ“˜Attribution Data

If you have access to install attribution data, you can set it using the reserved keys above. RevenueCat itself is not an attribution network and can not automatically populate this information.

Once attribution data is set for a subscriber, it can't be changed. This way attribution data can be associated with the original installation without getting overwritten.

Reserved attributes can be written directly by setting the key (don't forget the $ prefix) or with special helper methods:

Purchases.shared.attribution.setEmail("test@example.com")
Purchases.shared.attribution.setPhoneNumber("+16505551234")
Purchases.shared.attribution.setDisplayName("John Appleseed")

Setting push tokens​

Push tokens can be used to engage with your users through Apple apns or Google cloud messaging. These can be saved in RevenueCat through system callbacks after the user accepts the push notification permissions in your app.

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
Purchases.shared.attribution.setPushToken(deviceToken)
}

Deleting Attributes​

Any attribute can be cleared by passing null or an empty string as the key value. Individual attributes can also be cleared for a specific user in their customer view.

Purchases.shared.attribution.setAttributes(["age": ""])

Reading Attributes​

You can access attributes through the REST API using a secret key, in webhooks, and through analytics integrations (Amplitude, Mixpanel, Segment). The customer view dashboard will also show a list of attributes for the individual user that you can edit.

πŸ“˜Accessing attributes

Attributes are write-only from the SDK. Reading attributes should only be done server-side through the webhooks or REST API.

Attributes are also included with transaction data for Scheduled Data Exports.

Next Steps​