Skip to main content

overwolf.profile.subscriptions.inapp API

Provides functions and events to help with user profile subscription in-app management.

important

Please check the subscriptions API sample app that demonstrates a primary usage in the API.
Please read all the info about app subscriptions here.

  • Permissions required: Subscription

Methods Reference

Events Reference

Types Reference

show(planId, theme, callback)

Version added: 0.170

Permissions required: Subscription

Shows the in-app subscription page as a modal window on top of the current window.

ParameterTypeDescription
planIdnumberThe plan Id to display
themeTheme enumOptional. "Dark" or "Light. If not defined, the default is light
callbackResult => voidReturns with the result

hide(callback)

Version added: 0.170

Permissions required: Subscription

Hide the current active in-app subscription modal window.

ParameterTypeDescription
callbackResult => voidReturns with the result

onInAppSubModalOpened

Version added: 0.170

Fired when a subscription in-app modal window is opened: with the following structure: InAppSubModalOpenedEvent Object

InAppSubModalOpenedEvent Object

ParameterTypeDescription
statusstring

onInAppSubModalClosed

Version added: 0.170

Fired when a subscription in-app modal window is closed: with the following structure: InAppSubModalClosedEvent Object

InAppSubModalClosedEvent Object

ParameterTypeDescription
statusstring

Theme enum

Version added: 0.174

OptionsDescription
LightLight
DarkDark