Entitlements

Get Entitlements

Changed on

Returns all entitlements for a user, including active subscriptions, one-time purchases, and expired items. Use this to determine what the user has access to.

get/iap/entitlements

Request

  • Base URL
    https://api.zerosettle.io/v1
  • URL
    https://api.zerosettle.io/v1/iap/entitlements
  • Auth
    API key in header X-ZeroSettle-Key

Query parameters

user_idstring

The user's external ID. Required unless email is provided.

emailstring

The user's email address. Deprecated -- use user_id instead.

Response

User entitlements

Changes

  • b6ecb8664b0eRevision changes
    • info

      added the optional property // to the response with the status

  • e4930343254cRevision changes
    • warning

      added the new grace_period enum value to the // response property for the response status

    • warning

      added the new past_due enum value to the // response property for the response status

    • info

      removed the billing_grace_period enum value from the // response property for the response status

    • info

      removed the billing_retry enum value from the // response property for the response status

    • info

      removed the revoked enum value from the // response property for the response status