Resolve introductory eligibility

Get the signed App Store introductory-offer decision for a purchase placement.

POSThttps://i.nuxie.ai/app-store/intro-eligibility

Get a signed introductory-offer decision for an App Store purchase. The SDK supplies the purchase placement and its authenticated Journey context when it calls this endpoint.

Request body

apiKeybodystringrequired

Publishable key for the app platform. A pk_test_ key selects test data; a pk_live_ key selects live data. Copy it from Connect your app.

distinctIdbodystringrequired

The identified or anonymous customer ID your app supplies to the SDK, rather than Nuxie’s internal customer record ID. See Customer identifiers.

journeyIdbodystringrequired

Journey containing the purchase.

experienceVersionIdbodystringrequired

Published Version containing the offer.

legIdbodystringrequired

Journey section identifier, as a lowercase SHA-256 hash.

descriptorSha256bodystringrequired

Lowercase SHA-256 hash of the release descriptor.

placementIdbodystringrequired

Purchase placement in the published Version.

transactionIdbodystringrequired

StoreKit transaction identifier used for eligibility.

All fields are required, non-empty strings of at most 255 bytes. Unknown fields are rejected. This endpoint uses camelCase field names, unlike purchase synchronization.

Response

tokenstringrequired

Signed introductory-offer eligibility token.

An unauthorized or unconfigured placement returns 404. Unavailable signing credentials return 503.

curl https://i.nuxie.ai/app-store/intro-eligibility \
  --header 'Content-Type: application/json' \
  --data '{
  "apiKey": "pk_test_example",
  "distinctId": "user-456",
  "journeyId": "journey-id",
  "experienceVersionId": "experience-version-id",
  "legId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "descriptorSha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "placementId": "placement-id",
  "transactionId": "storekit-transaction-id"
}'

{
  "token": "signed-eligibility-token"
}