Introduction
Reference
A valid request URL is required to generate request examples{
"authenticated": true,
"user": {
"id": "<string>",
"email": "[email protected]",
"first_name": "<string>",
"last_name": "<string>"
},
"tab": {
"test_mode": true,
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>",
"base_unit": 123
},
"total": {
"amount": 123,
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>",
"base_unit": 123
}
},
"limit": {
"amount": 123,
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>",
"base_unit": 123
}
},
"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": "<string>",
"price": {
"amount": 123,
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>",
"base_unit": 123
}
},
"status": "completed",
"metadata": {},
"entitlement_status": {
"content_key": "<string>",
"has_entitlement": true,
"expires": "2023-11-07T05:31:56Z",
"recurs_at": "2023-11-07T05:31:56Z"
}
}
]
}
}Retrieve current customer
Retrieve the current customer.
If the user is authenticated, retrieve the customer’s current tab.
For unauthenticated requests, retrieve a predicted currency and tab limit based on the user’s location.
A valid request URL is required to generate request examples{
"authenticated": true,
"user": {
"id": "<string>",
"email": "[email protected]",
"first_name": "<string>",
"last_name": "<string>"
},
"tab": {
"test_mode": true,
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>",
"base_unit": 123
},
"total": {
"amount": 123,
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>",
"base_unit": 123
}
},
"limit": {
"amount": 123,
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>",
"base_unit": 123
}
},
"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": "<string>",
"price": {
"amount": 123,
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>",
"base_unit": 123
}
},
"status": "completed",
"metadata": {},
"entitlement_status": {
"content_key": "<string>",
"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 resourcesAuthorizations
Supertab OAuth2 flow for CAPI. See Authentication.
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.
Response
Successful 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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
ISO2417 currency code
Full name
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
The current total value of purchases made on this tab
Show child attributes
Show child attributes
Price amount expressed in currency base units
The price's currency
Show child attributes
Show child attributes
ISO2417 currency code
Full name
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
The limit which when reached will require the customer to make payment.
Show child attributes
Show child attributes
Price amount expressed in currency base units
The price's currency
Show child attributes
Show child attributes
ISO2417 currency code
Full name
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
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.
Show child attributes
Show child attributes
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.
An amount of money
Show child attributes
Show child attributes
Price amount expressed in currency base units
The price's currency
Show child attributes
Show child attributes
ISO2417 currency code
Full name
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
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 The customer's access (if any) as a result of this purchase
Show child attributes
Show child attributes
The content_key being checked
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.
Was this page helpful?