Sign in
Entitlements

Claim Entitlement

Transfers an existing StoreKit entitlement to the calling user. Used when an Apple ID's StoreKit subscription is owned by a different ZeroSettle account and needs to be moved to the current account (account migration, support flows, sandbox testing). The backend verifies the supplied JWS, revokes the entitlement from the previous owner, and grants it to user_id in a single atomic transaction.

post/iap/claim-entitlement/

Request body

jws_representationstring required

The StoreKit 2 transaction's JWS representation string for the entitlement being claimed.

user_idstring required

The external user ID that should receive the entitlement.

Response

Claim processed

statusstring required
claimedboolean required

True if the entitlement was transferred to the current user. False when the entitlement already belonged to the current user (no-op).

product_idstring

Reference ID of the claimed product. Present when claimed is true.

original_transaction_idstring

StoreKit originalTransactionId of the claimed entitlement. Present when claimed is true.

Example response

{
  "status": "ok"
}

Changes

Changed in 2 of the 11 revisions of this API.11