docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class Entitlement

    An object describing the Entitlement checked for a given Product.

    Inheritance
    object
    Entitlement
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.Purchasing
    Assembly: Unity.Purchasing.dll
    Syntax
    public class Entitlement

    Properties

    ErrorMessage

    Optional message describing the entitlement result. Can be null if no message is provided.

    Declaration
    public string? ErrorMessage { get; }
    Property Value
    Type Description
    string

    Order

    Returns the Order associated with the entitled product. The Order will be a PendingOrder if the purchase needs to be confirmed via ConfirmPurchase, otherwise, the Order will be a ConfirmedOrder if the purchase has been confirmed. If the product is not entitled, the Order will be null.

    Declaration
    public Order? Order { get; }
    Property Value
    Type Description
    Order

    Product

    The product being checked for entitlement. May be null if the entitlement check failed early.

    Declaration
    public Product? Product { get; }
    Property Value
    Type Description
    Product

    Status

    The status of entitlement.

    Declaration
    public EntitlementStatus Status { get; }
    Property Value
    Type Description
    EntitlementStatus
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)