Retrieve current customer

Retrieve the current customer.

If the user is authenticated, retrieves the customer’s current tab.

For unauthenticated requests, retrieves a predicted currency and tab limit based on the user’s location.

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

authenticated

boolean

required

Does this represent an authenticated user, or has Supertab based adjacent details on the user's location

tab

object

required

The Tab is at the heart of Supertab. It aggregates purchases customers make and tracks when they are required to make payment.

While the Tab powers much of our underlying behaviour you will not often directly interact with it.

Show child attributes

tab.test_mode

boolean

required

Is this a test mode tab.

Test mode tabs grant entitlement as usual but will not result in actual charges to customers. Test mode tabs are generated from test clients.

tab.currency

object

required

The currency of the tab. All purchases on this tab must be made in this currency.

Show child attributes

tab.currency.code

string

required

ISO2417 currency code

Example:

"USD"

tab.currency.name

string

required

Full name

Example:

"US Dollar"

tab.currency.symbol

string

required

Unicode currency symbol

Example:

"$"

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

tab.total

object

required

The current total value of purchases made on this tab

Show child attributes

tab.total.amount

integer

required

Price amount expressed in currency base units

Example:

50

tab.total.currency

object

required

The price's currency

Show child attributes

tab.total.currency.code

string

required

ISO2417 currency code

Example:

"USD"

tab.total.currency.name

string

required

Full name

Example:

"US Dollar"

tab.total.currency.symbol

string

required

Unicode currency symbol

Example:

"$"

tab.total.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

tab.limit

object

required

The limit which when reached will require the customer to make payment.

Show child attributes

tab.limit.amount

integer

required

Price amount expressed in currency base units

Example:

50

tab.limit.currency

object

required

The price's currency

Show child attributes

tab.limit.currency.code

string

required

ISO2417 currency code

Example:

"USD"

tab.limit.currency.name

string

required

Full name

Example:

"US Dollar"

tab.limit.currency.symbol

string

required

Unicode currency symbol

Example:

"$"

tab.limit.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

tab.purchases

object[]

required

Details of what this customer has purchased from your merchant account.

The purchases of the user that have been made with the other merchants are shown as a single purchase, which accumulates all totals into one and has no Purchase ID.

Show child attributes

tab.purchases.id

string | null

required

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

Example:

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

tab.purchases.offering_id

string | null

required

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

Example:

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

tab.purchases.purchased_at

string | null

required

The time the purchase completed.

Example:

"2025-01-01T12:00:00Z"

tab.purchases.completed_at

string | null

required

The time the purchase completed.

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

Example:

"2025-01-01T12:00:00Z"

tab.purchases.description

string

required

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

Example:

"The Leek - 24 Hours Time Pass"

tab.purchases.price

object

required

An amount of money

Show child attributes

tab.purchases.price.amount

integer

required

Price amount expressed in currency base units

Example:

50

tab.purchases.price.currency

object

required

The price's currency

Show child attributes

tab.purchases.price.currency.code

string

required

ISO2417 currency code

Example:

"USD"

tab.purchases.price.currency.name

string

required

Full name

Example:

"US Dollar"

tab.purchases.price.currency.symbol

string

required

Unicode currency symbol

Example:

"$"

tab.purchases.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

tab.purchases.status

enum<string>

required

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

Available options:

completed,

pending,

abandoned

tab.purchases.metadata

object

required

Freeform metadata associated with the purchase.

This can be used for e.g associating the purchase with a user identifier in your system

Show child attributes

tab.purchases.metadata.{key}

tab.purchases.entitlement_status

object | null

required

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

Show child attributes

tab.purchases.entitlement_status.content_key

string

required

The content_key being checked

Example:

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

tab.purchases.entitlement_status.has_entitlement

boolean

required

If the customer has access to this content

tab.purchases.entitlement_status.expires

string | null

required

When the customer's access will expire

tab.purchases.entitlement_status.recurs_at

string | null

required

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