Upgrade Offers

Get Upgrade Offer

Changed on

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

get/iap/upgrade-offer

Request

  • Base URL
    https://api.zerosettle.io/v1
  • URL
    https://api.zerosettle.io/v1/iap/upgrade-offer
  • Auth
    API key in header X-ZeroSettle-Key

Query parameters

user_idstring required

The user's external ID.

product_idstring

Specific product to check upgrade eligibility for.

Response

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.

Changes