Retrieve site

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-version

string

required

The version of the Customer API you are using.

x-supertab-client-id

string

required

Your Client ID with Supertab. Used to identify the website on which Customer is making a Purchase.

Example:

"live_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"

Response

200

application/json

Successful Response

A site is any website, SaaS product or any other place you deploy Supertab.

It is the top level object in your inventory and contains all offerings.

name

string

required

The name of the site

url

string

required

URL of the site. Supertab will not authenticate customers unless this matches the domain you are serving from.

Minimum length: 1

Example:

"https://supertab.co"

auth_redirect_uri

string

required

Passed to Supertab when authenticating customers on this site

Minimum length: 1

Example:

"https://signon.supertab.co/auth-proxy"

logo_url

string | null

required

The URL of the logo for this site provided to Supertab

Minimum length: 1

content_keys

string[]

required

List of content_keys to use when checking entitlement to your site.

offerings

object[]

required

Offerings are what is available for customers to purchase.

You can define your available offerings in the Supertab Business Portal.

Show child attributes

offerings.id

string

required

Example:

"offering.cf637646-71a4-430d-aaea-a66f1a48a83c"

offerings.description

string

required

Customer facing name for the offering.

Example:

"1 week access to theleek.com"

offerings.entitlement_details

object | null

required

Specifies the nature and duration of purchased entitlement.

Where you have chosen to have Supertab manage entitlements for you, customer's purchasing such an offering will be granted entitlement to the content associated with the offering for the length of time specified.

Show child attributes

offerings.entitlement_details.duration

string

required

Duration of the timepass, as {length}{unit}.

Possible units:

Directive	Meaning
y	years
M	months
w	weeks
d	days
h	hours
m	minutes
s	seconds

Examples:

{
  // 1 year
  "duration": "1y",
  // 2 months
  "duration": "2M",
  // 3 weeks
  "duration": "3w",
  // 4 days
  "duration": "4d",
  // 5 hours
  "duration": "5h",
  // 6 minutes
  "duration": "6m",
  // 7 seconds
  "duration": "7s"
}

Required string length: 2 - 9

offerings.entitlement_details.is_recurring

boolean

required

Is entitlement sold on a recurring (subscription) basis

offerings.entitlement_details.content_key

string

required

The content key being purchased, if you have chosen to have Supertab manage customer entitlement for you.

Example:

{ "duration": "1w" }

offerings.price

object

required

The price of this offering.

The available price is customer-aware when possible, Supertab restricts some customers to certain currencies depending on their location and prior interactions with Supertab.

Show child attributes

offerings.price.amount

integer

required

Price amount expressed in currency base units

Example:

50

offerings.price.currency

object

required

The price's currency

Show child attributes

offerings.price.currency.code

string

required

ISO2417 currency code

Example:

"USD"

offerings.price.currency.name

string

required

Full name

Example:

"US Dollar"

offerings.price.currency.symbol

string

required

Unicode currency symbol

Example:

"$"

offerings.price.currency.base_unit

integer

required

The relationship between the currency's minor and major unit.

For most currencies including USD & EUR this will be 100. For currencies which do not use decimals (e.g JPY) this will 1

Example:

100

offerings.is_pay_now

boolean

required

Offering requires upfront payment, customer will be taken to checkout immediately on purchase.

Used to control Call To Action during purchase confirmation.

experiences

object[]

required

When using Supertab to manage your sales UI, this list of experiences contains the information we use to display an Experience to your customers.

Show child attributes

experiences.id

string

required

The experience ID

Example:

"experience.cf637646-71a4-430d-aaea-a66f1a48a83c"

experiences.name

string

required

The experience name

experiences.type

enum<string>

required

The type of the experience, used by Supertab to determine how to display the experience UI

Available options:

basic_paygate,

basic_supertab_button,

rich_paygate,

rich_supertab_button

experiences.offerings

string[]

required

List of offering IDs attached to this experience.

This includes all possible offerings sold by this experience, details of how to display these to customers are found in ui_config.

experiences.configuration

object

required

Show child attributes

experiences.configuration.ui_config

object

required

Used by Supertab to control look, feel & branding

experiences.configuration.on_close

string | null

required

Used by Supertab to control experience dismissal behaviour

experiences.configuration.upsells

object[]

required

Used by Supertab to associate Offerings together for best customer value

Show child attributes

experiences.configuration.upsells.main_offering

string

required

Example:

"offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"

experiences.configuration.upsells.upsell_offering

string

required

Example:

"offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"

experiences.configuration.upsells.discount

number

required

test_mode

boolean

required

See Test Mode's Documentation for details