v1

latestOpenAPI 3.0.32026-07-132534113.7 KB

Upgrade Offers

Get Upgrade Offer

Checks if a user is eligible for a subscription upgrade and returns available upgrade options.

get/iap/upgrade-offer

user_idstring required

The user's external ID.

product_idstring

Specific product to check upgrade eligibility for.

Upgrade offer details

eligibleboolean

Whether the user is eligible for an upgrade.

current_product_idstring

The user's current subscription product ID.

variant_idinteger nullable

Experiment variant ID if the upgrade offer is part of an A/B test.