Skip to main content

Subscriptions API

The Overwolf Subscriptions API relies on a combination of endpoints and deeplinks, detailed in this page.

Endpoints​

The following is a list of endpoints exposed by the Overwolf Subscriptions API, to handle the most common operations.

For live examples of the different endpoints, please check out the Tebex Subs Sample App.

Checkout​

Generates a checkout page for a specific subscription plan (package).

Request Type: 'GET'
Hostname: 'subscriptions-api.overwolf.com'
Path: '/checkout/${STORE_ID}/${PACKAGE_ID}'
Search Params:
  extensionId: string
  userId: string
  discordId (required when using discord actions): string

Result: 'Checkout Webpage'

This request redirects directly to the page, and as such, should be opened as a link in the users' browser.

Subscriptions​

Returns a list of all active subscription plans (packages) for this App for the relevant user.

Request Type: 'GET'
Hostname: 'subscriptions-api.overwolf.com'
Path: '/subscriptions/${STORE_ID}'
Search Params:
  extensionId: string
Headers:
  Authorization: 'Bearer ${token}'

Result: 'Array of:'
  userId: 'string'
  packageId: 'number'

Packages​

Returns a list of all available subscription plans (packages) for this App.

Request Type: 'GET'
Hostname: 'subscriptions-api.overwolf.com'
Path: '/packages/${STORE_ID}'
Search Params:
  extensionId: string

Result: 'Array of:'
  base_price: 'number'
  category: 
    id: 'number'
    name: 'string'
  created_at: 'string'
  description: 'string'
  disable_gifting: 'boolean'
  disable_quantity: 'boolean'
  discount: 'number'
  expiration_date?: 'string'
  id: 'number'
  image?: 'string'
  name: 'string'
  sales_tax: 'number'
  total_price: 'number'
  type: 'subscription | single'
  updated_at: 'string'

The following is a list of deeplinks used by the Overwolf Subscriptions API, to handle calls back to the application.

Success​

Invoked when a user successfuly finishes the checkout flow.

`${YOUR_DEEPLINK_SCHEME}://?result=success`

Cancelled​

Invoked when a user cancelled the checkout flow explicitly (does not fire if they closed the tab).

`${YOUR_DEEPLINK_SCHEME}://?result=cancel`