v1
latestOpenAPI 3.0.32026-07-132534113.7 KBProducts
Get Products
Fetches the product catalog for your app, including web and StoreKit prices, checkout configuration, trial eligibility, and any active migration campaign. Pass user_id to get per-user trial eligibility.
get/iap/products
Query parameters
user_idstring
The user's external ID. When provided, the response includes per-user is_trial_eligible on each product.
demo'migration' | 'upgrade'
Debug-only. Surfaces a dashboard-configured campaign as if the requesting user were eligible for it, regardless of their real subscription state. Lets developers preview their tip UI without crafting a specific test account.
- migration returns the configured MigrationCampaign (Switch & Save) on config.migration (and config.offer mirror with flow_type=migration).
- upgrade returns the configured UpgradeOfferConfig (Upgrade & Save) on config.offer with flow_type=upgrade. Uses the first upgrade_paths entry as the preview source/target. savings_percent is 0 for demo previews — accurate proration requires a real billing cycle.
- Honored only on test-mode publishable keys (zs_pk_test_*). Live keys silently ignore the flag. Impressions are NOT counted on demo requests. Any other value (including the legacy true) drops the bypass and the normal user-state resolver runs.
Response
Product catalog with checkout configuration