v1

latestOpenAPI 3.0.32026-07-132534113.7 KB

User Offer

Get User Offer

Canonical offer + subscription-state resolver (SDK 1.2+). Returns the user's current subscription variant plus exactly one offer decision (no_action, migrate_storekit_to_web, upgrade_storekit_to_web, or upgrade_web_to_web). Replaces the overlapping /iap/products/ offer config, /iap/upgrade-offer/, and ad-hoc status parsing with a single typed contract. Legacy endpoints remain supported for older SDKs.

get/iap/user-offer

Query parameters

user_idstring required

The user's external ID.

Response

Canonical user offer + subscription state

user_idstring required

Echoes the user_id query parameter.

app_idinteger required

Internal ZeroSettle app ID that owns the publishable key.

is_sandboxboolean required

Resolved environment — true when the request was authenticated with a sandbox publishable key.

server_timestring date-time required

Server-side timestamp at which the response was resolved (ISO 8601). Useful for client-side cache invalidation.