Introduction
Reference
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.
{
"authenticated": true,
"tab": {
"test_mode": true,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
},
"total": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
},
"limit": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
},
"purchases": [
{
"id": "purchase.cf637646-71a4-430d-aaea-a66f1a48a83c",
"offering_id": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
"onetime_offering_id": "onetime_offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
"purchased_at": "2025-01-01T12:00:00Z",
"completed_at": "2025-01-01T12:00:00Z",
"description": "The Leek - 24 Hours Time Pass",
"price": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
},
"status": "completed",
"metadata": {},
"entitlement_status": {
"content_key": "site.cf637646-71a4-430d-aaea-a66f1a48a83c",
"has_entitlement": true,
"expires": "2023-11-07T05:31:56Z",
"recurs_at": "2023-11-07T05:31:56Z"
}
}
]
}
}Required Scopes
capi:read - Read access to Customer API resources
Authorizations
OAuth 2.0 flow. The following scopes are available:
capi:read: Access to view capicapi:write: Access to write for capi
Headers
The version of the Customer API you are using.
Your Client ID with Supertab. Used to identify the website on which Customer is making a Purchase.
"live_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
"test_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
Response
This represents either an authenticated user or location-based adjacent details inferred by Supertab
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.
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.
The currency of the tab. All purchases on this tab must be made in this currency.
ISO2417 currency code
"USD"
Full name
"US Dollar"
Unicode currency symbol
"$"
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
100
The current total value of purchases made on this tab
Price amount expressed in currency base units
50
The price's currency
ISO2417 currency code
"USD"
Full name
"US Dollar"
Unicode currency symbol
"$"
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
100
The limit which when reached will require the customer to make payment.
Price amount expressed in currency base units
50
The price's currency
ISO2417 currency code
"USD"
Full name
"US Dollar"
Unicode currency symbol
"$"
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
100
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 a null value instead of a Purchase ID.
When a Purchase has been made with you, shows the ID of the Purchase. Otherwise obfuscated and is shown as null.
"purchase.cf637646-71a4-430d-aaea-a66f1a48a83c"
Which offering was purchased, if this purchase resulted from purchasing a pre-defined offering.
"offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
Which one-time offering was purchased, if this purchase resulted from purchasing a one-time offering.
"onetime_offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
The time the purchase completed.
"2025-01-01T12:00:00Z"
The time the purchase completed.
Where Supertab requires a payment this will be null until the payment completes.
"2025-01-01T12:00:00Z"
A summary of the purchase, usually including the site name and the type of a given entitlement.
"The Leek - 24 Hours Time Pass"
"1 Month Subscription"
An amount of money
Price amount expressed in currency base units
50
The price's currency
ISO2417 currency code
"USD"
Full name
"US Dollar"
Unicode currency symbol
"$"
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
100
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
completed, pending, abandoned Freeform metadata associated with the purchase.
This can be used for e.g associating the purchase with a user identifier in your system
The customer's access (if any) as a result of this purchase
The content_key being checked
"site.cf637646-71a4-430d-aaea-a66f1a48a83c"
If the customer has access to this content
When the customer's access will expire
If this access is a result of a subscription, the time the subscription will renew unless cancelled by the customer.
{
"authenticated": true,
"tab": {
"test_mode": true,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
},
"total": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
},
"limit": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
},
"purchases": [
{
"id": "purchase.cf637646-71a4-430d-aaea-a66f1a48a83c",
"offering_id": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
"onetime_offering_id": "onetime_offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
"purchased_at": "2025-01-01T12:00:00Z",
"completed_at": "2025-01-01T12:00:00Z",
"description": "The Leek - 24 Hours Time Pass",
"price": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
},
"status": "completed",
"metadata": {},
"entitlement_status": {
"content_key": "site.cf637646-71a4-430d-aaea-a66f1a48a83c",
"has_entitlement": true,
"expires": "2023-11-07T05:31:56Z",
"recurs_at": "2023-11-07T05:31:56Z"
}
}
]
}
}