Retrieve site

GET

site

{
  "name": "<string>",
  "url": "https://supertab.co",
  "auth_redirect_uri": "https://signon.supertab.co/auth-proxy",
  "logo_url": "<string>",
  "content_keys": [
    "<string>"
  ],
  "offerings": [
    {
      "id": "offering.cf637646-71a4-430d-aaea-a66f1a48a83c",
      "description": "1 week access to theleek.com",
      "entitlement_details": {
        "content_key": "site.cf637646-71a4-430d-aaea-a66f1a48a83c",
        "duration": "1w",
        "is_recurring": false
      },
      "price": {
        "amount": 50,
        "currency": {
          "code": "USD",
          "name": "US Dollar",
          "symbol": "$",
          "base_unit": 100
        }
      },
      "is_pay_now": true
    }
  ],
  "experiences": [
    {
      "id": "experience.cf637646-71a4-430d-aaea-a66f1a48a83c",
      "name": "<string>",
      "type": "basic_paygate",
      "offerings": [
        "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
      ],
      "configuration": {
        "ui_config": {},
        "on_close": "<string>",
        "upsells": [
          {
            "main_offering": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
            "upsell_offering": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
            "discount": 123
          }
        ]
      }
    }
  ],
  "test_mode": true
}

Required Scopes

capi:read - Read access to Customer API resources

Headers

x-api-version

string

default:2025-04-01

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.

Examples:

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

"test_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

Examples:

"https://supertab.co"

auth_redirect_uri

string

required

Passed to Supertab when authenticating customers on this site

Minimum length: 1

Examples:

"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.

offerings.id

string

required

Examples:

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

offerings.description

string

required

Customer facing name for the offering.

Examples:

"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.

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.

Examples:

{
  "content_key": "site.cf637646-71a4-430d-aaea-a66f1a48a83c",
  "duration": "1w",
  "is_recurring": false
}

{
  "content_key": "site.cf637646-71a4-430d-aaea-a66f1a48a83c",
  "duration": "1M",
  "is_recurring": true
}

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.

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.

test_mode

boolean

required

See Test Mode's Documentation for details

Retrieve current customer Purchase an offering

{
  "name": "<string>",
  "url": "https://supertab.co",
  "auth_redirect_uri": "https://signon.supertab.co/auth-proxy",
  "logo_url": "<string>",
  "content_keys": [
    "<string>"
  ],
  "offerings": [
    {
      "id": "offering.cf637646-71a4-430d-aaea-a66f1a48a83c",
      "description": "1 week access to theleek.com",
      "entitlement_details": {
        "content_key": "site.cf637646-71a4-430d-aaea-a66f1a48a83c",
        "duration": "1w",
        "is_recurring": false
      },
      "price": {
        "amount": 50,
        "currency": {
          "code": "USD",
          "name": "US Dollar",
          "symbol": "$",
          "base_unit": 100
        }
      },
      "is_pay_now": true
    }
  ],
  "experiences": [
    {
      "id": "experience.cf637646-71a4-430d-aaea-a66f1a48a83c",
      "name": "<string>",
      "type": "basic_paygate",
      "offerings": [
        "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
      ],
      "configuration": {
        "ui_config": {},
        "on_close": "<string>",
        "upsells": [
          {
            "main_offering": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
            "upsell_offering": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
            "discount": 123
          }
        ]
      }
    }
  ],
  "test_mode": true
}

Introduction

Reference

Guides

Endpoints

Required Scopes

Headers

Response

Introduction

Reference

Guides

Endpoints

​Required Scopes

Headers

Response

Required Scopes