EOS_Ecom_Entitlement

EOS API reference page for EOS_Ecom_Entitlement

2 mins to read

This data structure is part of the Ecom Interface.

Remarks

Contains information about a single entitlement associated with an account. Instances of this structure are created by EOS_Ecom_CopyEntitlementByIndex, EOS_Ecom_CopyEntitlementByNameAndIndex, or EOS_Ecom_CopyEntitlementById. They must be passed to EOS_Ecom_Entitlement_Release.

Properties

EOS_Ecom_Entitlement

PropertyValue
int32_t ApiVersionAPI Version: Set this to EOS_ECOM_ENTITLEMENT_API_LATEST.
EOS_Ecom_EntitlementName EntitlementNameName of the entitlement
EOS_Ecom_EntitlementId EntitlementIdID of the entitlement owned by an account
EOS_Ecom_CatalogItemId CatalogItemIdID of the item associated with the offer which granted this entitlement
int32_t ServerIndexIf queried using pagination then ServerIndex represents the index of the entitlement as it exists on the server. If not queried using pagination then ServerIndex will be -1.
EOS_Bool bRedeemedIf true then the catalog has this entitlement marked as redeemed
int64_t EndTimestampIf not -1 then this is a POSIX timestamp that this entitlement will end