Restore

Restore Purchases

Changed on

Restores purchases for a user by linking entitlements from a previous identity (matched by email) to the current user ID. Useful when a user reinstalls the app or signs in on a new device.

post/iap/restore-purchases

Request

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

Request body

emailstring required

The user's email address to match against previous purchases.

user_idstring required

The user's current external ID to restore purchases to.

Response

Purchases restored

statusstring
restored_countinteger

Number of entitlements restored.

Example response

{
  "status": "ok"
}

Changes