GET
/
purchases
/
{purchase_id}
{
  "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

Headers

​
x-api-version
string
default:2025-04-01

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.

Examples:

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

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

Path Parameters

​
purchase_id
string
required

An ID of a Purchase

Examples:

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

Response

200
application/json
Successful Response
​
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.

Examples:

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

​
offering_id
string | null
required

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

Examples:

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

​
onetime_offering_id
string | null
required

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

Examples:

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

​
purchased_at
string | null
required

The time the purchase completed.

Examples:

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

​
completed_at
string | null
required

The time the purchase completed.

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

Examples:

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

​
description
string
required

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

Examples:

"The Leek - 24 Hours Time Pass"

"1 Month Subscription"

​
price
object
required

An amount of money

​
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
​
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

​
entitlement_status
object | null
required

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