Purchases a pre-defined offering by placing it on the customer's current tab.

Depending on the customer's existing relationship with Supertab they may be required to make purchases
in a specific currency. Check /customers/me for information on what currency the customer makes purchases in.

If the new purchase causes the tab to become full a payment is required before the purchase will complete.

Purchase an offering

Details of what to do next to complete pending purchases

Forward the user here to start e.g. a checkout session which should then be opened in a pop-up window.

Reason

ActionRequiredDetails

Supertab is available in many currencies.

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`

Base Unit

Code

Name

Symbol

Currency

A customer's entitlement status to a given content_key

Content Key

Expires

If the customer has access to this content

Has Entitlement

If this access is a result of a subscription, the time the subscription will renew unless cancelled by the customer.

Recurs At

EntitlementStatus

Price amount expressed in currency base units

Amount

Price

The time the purchase completed.

Where Supertab requires a payment this will be null until the payment completes.

Completed At

A summary of the purchase, usually including the site name and the type of a given entitlement.

Description

The customer's access (if any) as a result of this purchase

When a Purchase has been made with you, shows the ID of the Purchase. Otherwise obfuscated and is shown as `null`.

Which offering was purchased, if this purchase resulted from purchasing a pre-defined offering.

Offering Id

Which one-time offering was purchased, if this purchase resulted from purchasing a one-time offering.

Onetime Offering Id

Purchased At

The status of the purchase.

Purchases may be pending or completed.

Only completed purchases grant access, pending purchases are purchases which require payment before entitlement is granted

Purchase

We use this enum to represent the status of a purchase.

The status can be:
- completed: the purchase was successfully completed
- pending: the purchase is pending
- abandoned: the purchase was abandoned

The logic to determine the status of a purchase is:
    PAY_LATER on Tab -> purchase.status
    PAY_NOW in a paid Tab -> completed
    PAY_NOW in an unpaid Tab -> pending

    Abandoned purchases are not being set at the moment.
    Purchases are going to be marked as abandoned when new pending
    purchases are added to the tab.

PurchaseStatus

Location

Message

Error Type

ValidationError

PurchaseOfferingRequest

OfferingPurchaseResult

HTTPValidationError

Supertab docs

Supertab is a novel digital payment solution, specifically designed to make small payments possible.

About Supertab

Open a new Supertab account, manage your payouts and team members

Account Management

Lists the countries, languages, and currencies supported by Supertab for merchants and consumers.

Internationalization

Monetize premium content using Supertab Experiences

Get Started

Create your Sites in order to begin using Supertab Experiences

Create Sites

Configure your inventory to start selling with Supertab

Configure Offerings and Pricing

Install the Supertab Basic Paygate or Purchase Button - the button to push quality journalism.

Set up Experiences

Understand how to use Test Mode to test integrations before go live

Test Mode

Leverage Supertab integration with Google Offerwall for no-code monetization within Google AdManager. 

With Google AdManager

Use browser JS purchase button integration

Purchase button

Enable powerful custom integrations with, Supertab.js, the Supertab Customer API and the Supertab Merchant API

Custom Integrations

Product Updates

Install the Supertab Basic Paygate or Purchase Button

Creates sites for the specified merchant, managed by the specified partner.

Given a list of names and urls, this endpoint will create a new site, a liveclient app
and a test client app if the site doesn't exist for the given merchant. If the site
already exists, both site and client apps will be updated.

The endpoint returns a list `sites` with info about the sites created/updated.

If an error happens during the creation or update of one or more sites, they will
be returned in the `errors` list. Otherwise, this list will be empty.

For use by Supertab partners.

Create sites (as a partner)

Creates an invitation to open a merchant account managed by a partner.

Create an invitation to open a merchant account

Retrieves the status of a merchant managed by a partner.

Check if a merchant is ready (transfers enabled), pending (transfers not enabled) or not created.

Retrieve the status of a managed merchant

Retrieves details of a specific purchase. Returns the current status and associated metadata of the purchase.
    Merchants can only access their own purchases.

Retrieve purchase

Retrieves details of a specific purchase intent. Merchants can only access their own purchase intents.

Retrieve purchase intent

Checks if user has access to content from a merchant

Introduction

Reference

Guides

Endpoints

Purchase an offering

Required Scopes

Headers

Body

Response