Permissions
Permissions object
The Permissions
object gives access to the following information:
Name | Description |
---|---|
originalApplicationVersion | The original version of the application when first acquired on the store. (iOS only) |
originalApplicationDate | The date when the application was installed from the store. |
subscriberId | Unique identifier for the subscriber of the app. For more information read the subscriber documentation. |
installationId | Unique identifier of the app installation. It changes if the user reinstalls the app. |
all | Array of Permission objects associated with this subscriber. |
Permission object
The Permission
object gives access to the following information:
Name | Description |
---|---|
permissionId | Permission identifier. |
isValid | true if the permission is from a valid in app purchase or subscription. |
expireDate | Contains the expiry date if the permission is from a subscription. |
accountableSkus | Array of AccountableSku objects that unlocked this permission. |
entitlement | Entitlement object. |
AccountableSku object
Information about the sku that determines the entitlement
of the Permission
that gives access to the following information:
Name | Description |
---|---|
isInTrialPeriod | true if the sku is in trial period. |
isInIntroOfferPeriod | true if the sku is in an introductory offer period. |
skuId | Sku Identifier. |
productId | Product identifier. |
store | The store object of the sku. |
Store object
The store
to which the sku belongs that gives the following information:
Value | Name | Description |
---|---|---|
1 | appStore | Apple app store |
2 | playStore | Google Play Store |
3 | paddleStore | Paddle Store |
Entitlement object
The entitlement
object gives access to the following entitlement status. In general any number greater or equal to 1 means a valid subscription.
Value | Status | Description |
---|---|---|
-10 | Paused | The customer pause the subscription. |
-9 | NeverBuy | The customer never bought this product. |
-8 | OtherRefund | The customer received a refund for the subscription. |
-7 | IssueRefund | The customer received a refund due to a perceived issue with the app. |
-6 | Upgraded | The system cancelled the subscription because the customer upgraded. |
-5 | ExpiredVoluntary | The customer intentionally cancelled the subscription. |
-4 | ProductNotAvailable | The product is no longer available. |
-3 | FailToAcceptIncrease | The customer did not accept the price increase. |
-2 | ExpiredFromBilling | The receipt is fully expired due to a billing issue. |
-1 | InRetry | The receipt is expired but the subscription is still in a billing-retry state. If a grace period is enabled this state excludes subscriptions in grace period. |
0 | MissingInfo | The receipt is out of date or there is another purchase issue. |
1 | ExpiredInGrace | The subscription expired but is in a grace period. |
2 | OffPlatform | The subscription is an off-platform subscription. |
3 | NonRenewing | The subscription is a non-renewing subscription. |
4 | AutoRenewOff | The subscription is active and auto-renew is off. |
5 | AutoRenewOn | The subscription is active and auto-renew is on. |
Checking permission status
You can check the current status of the permission using the permissions method or after a purchase.
Updated over 1 year ago