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.

GET /customers/me

Error

A valid request URL is required to generate request examples

200

{
  "authenticated": true,
  "user": {
    "id": "<string>",
    "email": "[e-mail]",
    "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 resources

Authorizations

Authorization · string · header · required

Supertab OAuth2 flow for CAPI. See Authentication.

Headers

x-api-version · string<date> · default: 9999-01-01

The version of the Customer API you are using.

x-supertab-client-id · string<tagged_id> · 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

authenticated · boolean · required

This represents either an authenticated user or location-based adjacent details inferred by Supertab

user · User · object · required

The user data of the authenticated user. This will be null for unauthenticated users

Show child attributes

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